-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add CompatHelper * setup docs
- Loading branch information
Showing
6 changed files
with
80 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: CompatHelper | ||
| on: | ||
| schedule: | ||
| - cron: 0 0 * * * | ||
| workflow_dispatch: | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| jobs: | ||
| CompatHelper: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check if Julia is already available in the PATH | ||
| id: julia_in_path | ||
| run: which julia | ||
| continue-on-error: true | ||
| - name: Install Julia, but only if it is not already available in the PATH | ||
| uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: '1' | ||
| arch: ${{ runner.arch }} | ||
| if: steps.julia_in_path.outcome != 'success' | ||
| - name: "Add the General registry via Git" | ||
| run: | | ||
| import Pkg | ||
| ENV["JULIA_PKG_SERVER"] = "" | ||
| Pkg.Registry.add("General") | ||
| shell: julia --color=yes {0} | ||
| - name: "Install CompatHelper" | ||
| run: | | ||
| import Pkg | ||
| name = "CompatHelper" | ||
| uuid = "aa819f21-2bde-4658-8897-bab36330d9b7" | ||
| version = "3" | ||
| Pkg.add(; name, uuid, version) | ||
| shell: julia --color=yes {0} | ||
| - name: "Run CompatHelper" | ||
| run: | | ||
| import CompatHelper | ||
| CompatHelper.main(; | ||
| subdirs=[ | ||
| "", | ||
| "docs", | ||
| ], | ||
| ) | ||
| shell: julia --color=yes {0} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} | ||
| # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: Documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - master # update to match your development branch (master, main, dev, trunk, ...) | ||
| tags: '*' | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| build: | ||
| permissions: | ||
| contents: write | ||
| statuses: write | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: '1' | ||
| - name: Install dependencies | ||
| run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' | ||
| - name: Build and deploy | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token | ||
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key | ||
| run: julia --project=docs/ docs/make.jl |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ea41fe1There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuliaRegistrator register()
ea41fe1There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Registration pull request created: JuliaRegistries/General/100083
Tip: Release Notes
Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.
To add them here just re-invoke and the PR will be updated.
Tagging
After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.
This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via: