-
Notifications
You must be signed in to change notification settings - Fork 3
Add release checklist #69
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
Open
hannahlanzrath
wants to merge
2
commits into
master
Choose a base branch
from
add_release_guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,66 @@ | ||
| --- | ||
| name: Release checklist | ||
| about: Checklist to make a release | ||
| title: '' | ||
| labels: 'maintenance' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| # CADET-Python Release Checklist | ||
|
|
||
| CADET-Python follows the semantic versioning system described at [semver.org](https://semver.org/). | ||
|
|
||
| CADET-Python is released direcntly from the master branch and deployed to PyPi via a GitHub workflow automatically, and to conda-forge semi-automatically. | ||
|
|
||
| The following checklist describes the steps to execute sequentially for creating a new release. | ||
|
|
||
| --- | ||
|
|
||
| ## Preparation | ||
|
|
||
| - [ ] Create a version bump commit `Bump version to vX.X.X`: | ||
| - Update the version number in | ||
| - `__init__.py` | ||
| - `zenodo.json` (two places), `cadet.hpp` and | ||
|
|
||
| --- | ||
|
|
||
| ## Creating the release on GitHub | ||
|
|
||
| - [ ] Go to [GitHub Releases](https://github.com/cadet/CADET-Core/releases/new): | ||
| - Set the release branch as the target | ||
| - Specify the tag `vX.X.X` according to semantic versioning | ||
| - Add release notes with sections for Added, Fixed, Changed, and Updated | ||
| - Publish the release. | ||
| - [ ] Check deployment on PyPi via the CI and the [PyPi CADET-Python website](https://pypi.org/project/CADET-Python/) | ||
| - [ ] Verify Zenodo archiving: | ||
| - Confirm that a version-specific DOI was created | ||
| - Ensure that the source code and associated files are archived | ||
| - Note that the [concept DOI](https://doi.org/10.5281/zenodo.14132721) remains constant | ||
|
|
||
| ## Deployment on pypi | ||
|
|
||
| - [ ] Check if the GitHub action with workflow file `python-publish.yml` ran successfully, fix if required. | ||
|
|
||
| ## Deployment on conda-forge | ||
|
|
||
| - [ ] Go to your fork of [cadet-feedstock](https://github.com/conda-forge/cadet-python-feedstock) or create one if it does not exist | ||
| - [ ] Create a new branch on your fork and change the file `recipe/meta.yaml`: | ||
| - install openSSL | ||
| - Generate the SHA256 key (replace `{{ version }}` with the semantic version number): | ||
| ```bash | ||
| curl -sL https://github.com/cadet/CADET-Python/archive/refs/tags/v{{ version }}.tar.gz | openssl sha256 | ||
| ``` | ||
| - Update the version number and SHA256 key | ||
| - Set the build number to zero (`build: number: 0`) | ||
| - [ ] Open a PR onto the `main` branch of `conda-forge/cadet-feedstock`, and complete the automatically generated checklist | ||
| - Note: to check if the license file is included, check the tarball (`https://github.com/cadet/CADET-Python/archive/refs/tags/v{{ version }}.tar.gz`) if the License file is in the location specified in the meta.yml in the variable `license_file` | ||
| - [ ] Wait for the automatic checks to pass | ||
| - [ ] Merge the pull request to trigger the conda-forge release | ||
| - [ ] Double check if the new version of cadet-python is on conda-forge | ||
|
|
||
| --- | ||
|
|
||
| ## Follow-up | ||
| - [ ] If this release checklist was updated, add these changes to the corresponding issue template | ||
Oops, something went wrong.
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.
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.
@hannahlanzrath something missing?