Add a release action #497
Draft
Add a release action #497
Conversation
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 action will build and deploy docs for a new release, copying
the built docs artifacts to both the dev and the {version} folders
in napari.github.io. It will also update the stable symlink to point
to the new version folder.
This action will be triggered by a new release tag pushed to the repo or
by manually trigerring the action with an input specifying the new version
(any input different from the default dev will trigger the action.)
|
I am creating this as a draft, since there will need to be at least some docs written around this strategy, and I was hoping to get some feedback before we commit to it. |
melissawm
commented
Sep 26, 2024
| run: sleep 5m | ||
|
|
||
| - name: Deploy Release Docs | ||
| if: (github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev')) |
There was a problem hiding this comment.
This is not correct, since it will update the symlink to release candidates as well.
| repo: napari.github.io | ||
| github_token: ${{ secrets.WORKFLOW_PAT }} | ||
| workflow_file_name: symlink-stable.yml | ||
| client_payload: '{"target_directory": "${{ github.event.inputs.target_directory || github.event.release.tag_name }}"}' |
There was a problem hiding this comment.
Next, we also need to add a step to update the version_switcher.json file.
| external_repository: napari/napari.github.io | ||
| publish_dir: ./html | ||
| publish_branch: gh-pages | ||
| destination_dir: ${{ github.event.inputs.target_directory || github.event.release.tag_name }} |
There was a problem hiding this comment.
This could potentially create a wrong folder if the wrong version string is passed as input to the action.
|
I think this makes sense to me and would make releases easier--they're happening more frequently now, so it's worth it! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References and relevant issues
Addresses #490
Closes #486
Depends on napari/napari.github.io#417
Description
This action will build and deploy docs for a new release, copying the built docs artifacts to both the dev and the {version} folders in napari.github.io. It will also update the stable symlink to point to the new version folder.
This action will be triggered by a new release tag pushed to the repo or by manually trigerring the action with an input specifying the new version (any input different from the default dev will trigger the action.)