@@ -70,7 +70,7 @@ That is,
70
70
or by running ` poetry version X.Y.Z ` or bumping according to a valid bump rule like ` poetry version minor `
71
71
(see poetry docs: https://python-poetry.org/docs/cli/#version ).
72
72
73
- 3 . Update the version identifier in ` CITATION.cff ` .
73
+ 3 . Update the version identifier in ` CITATION.cff ` and ` meta.yaml ` .
74
74
75
75
4 . Update ` changelog.md ` to reflect that the version is now "released" and revisit ` README.md ` to keep it up to date.
76
76
@@ -81,21 +81,18 @@ That is,
81
81
6 . When you are satisfied that the release branch is ready, merge the PR into ` main ` .
82
82
83
83
7 . Check out the ` main ` branch, pull the merged changes, and tag the newly created merge commit with the
84
- desired version ` X.Y.Z ` and push the tag upstream.
84
+ desired version ` X.Y.Z ` and push the tag upstream. This will kick off the automatic release process.
85
85
86
86
### Automatic Release Process
87
87
We use GitHub Actions for automatic release process that responds to pushes of git tags. When a tag matching
88
88
a semantic version (` [0-9]+.[0-9]+.[0-9]+* ` or ` test-release/[0-9]+.[0-9]+.[0-9]+* ` ) is pushed, the release workflow
89
89
runs as follows:
90
90
91
- 1 . Build distribution artifacts for both Anaconda and PyPI distribution .
91
+ 1 . Build distribution artifacts for PyPI.
92
92
2 . Push the PyPI distribution artifacts to PyPI. Pushes to TestPyPI if tag starts with ` test-release ` .
93
- 3 . Push the Anaconda distribution to the ` lasp ` Anaconda channel.
94
- Pushes to the ` test-release ` labeled channel if tag starts with ` test-release ` .
95
- 4 . Create a GitHub Release from the distributed artifacts.
96
-
97
- Release notes are automatically generated from commit history and the Release name is taken from
98
- the basename of the tag.
93
+ 3 . Build and push the Anaconda distribution to the ` lasp ` Anaconda channel.
94
+ Pushes with a ` test-release ` label if tag starts with ` test-release ` , otherwise labels as ` main ` .
95
+ 4 . Create a GitHub Release that includes auto-generated release notes and the source code.
99
96
100
97
#### Official Releases
101
98
Official releases are published to the public PyPI (even if they are release candidates like ` 1.2.3rc1 ` ). This differs
0 commit comments