-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update CI setup and GitHub organization references #5
Conversation
This updates the following things: - CompatHelper and TagBot need particular permissions set; this commit sets them per the respective repositories' README files. - Unit testing and documentation deployment are consolidated into one file, in keeping with most other packages in the ecosystem. - Unit tests are run on: - The latest Ubuntu version available on Actions instead of 20.04 - Julia 1.6, latest 1.x (1.10 as of this writing), and nightly - x86_64 (this was always the case but it's now explicit) This does NOT update the Codecov action to its most recent version, v4. That requires a `CODECOV_TOKEN` repository secret. In the meantime, v2 should continue to work (I think) until it's EOL.
Currently everything references Juice-jl.
Both documentation building and installation instructions.
There 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.
Thanks a lot for the changes, mostly LGTM.
Few minor comments inline.
Main questionbefore merging:
- How can we test the CI run before merging it? To see whether the doc build and upload happend correctly for example.
inputs: | ||
lookback: | ||
default: 3 |
There 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.
does this mean it looks backs 3 commits and tries to tag all of them (if not already)?
There 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.
To be perfectly honest, I'm not sure; I just took that from the TagBot repository README.
docs: | ||
name: Documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: julia-actions/julia-buildpkg@latest | ||
- uses: julia-actions/julia-docdeploy@latest | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} |
There 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.
In the past we wanted to trigger doc only builds wihtout running tests but I guess merging them should be fine.
There 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.
Up to you, I can split them back apart if that's a more convenient workflow for you.
There 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.
Should be okay to merge them.
.github/workflows/ci.yml
Outdated
workflow_dispatch: | ||
|
There 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.
Does it make sense to keep workflow_dispatch
? In the past was useful for debuggin the actions.
Since I'm submitting this PR from a fork, the workflows need to be approved before they're run. |
Thanks, seems I don't have access anymore to approve so need to wait until someone else takes a look, and merge this. |
Who would still have access? @guyvdbroeck, perhaps? |
Thanks for the workflow and PR approval, @guyvdbroeck! Looks like CI is happy. I think you'll need to be the one to merge as well given that @khosravipasha doesn't (and obviously I don't) have commit access. |
Looking at the CI log now that this is merged, it appears you'll need to regenerate the |
@ararslan Thanks for checking the logs, seems CI passed but did not deploy because of |
Great! Once you generate a new SSH key and add it as a repository secret, you should be able to rerun the Documentation job triggered by merging this PR, which you can find in the Actions tab. |
Great Thanks, adding the steps here for future refrences.
|
The CI update (first commit) encompasses the following:
Note that I did not update the Codecov action to its most recent version, v4, as that requires a
CODECOV_TOKEN
repository secret. See the Codecov documentation for more information. In the meantime, v2 should continue to work (I think) until it's EOL.The other two commits are replacing references to the Juice-jl GitHub organization with Tractables.