Skip to content

Commit 6ab671e

Browse files
medley56greglucas
andauthored
Tiny fixes found during other work (#157)
* Tiny fixes found during other work * Update docs/source/developers.md Co-authored-by: Greg Lucas <[email protected]> --------- Co-authored-by: Greg Lucas <[email protected]>
1 parent bc9cbb3 commit 6ab671e

File tree

2 files changed

+6
-10
lines changed

2 files changed

+6
-10
lines changed

docs/source/developers.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ That is,
7070
or by running `poetry version X.Y.Z` or bumping according to a valid bump rule like `poetry version minor`
7171
(see poetry docs: https://python-poetry.org/docs/cli/#version).
7272

73-
3. Update the version identifier in `CITATION.cff`.
73+
3. Update the version identifier in `CITATION.cff` and `meta.yaml`.
7474

7575
4. Update `changelog.md` to reflect that the version is now "released" and revisit `README.md` to keep it up to date.
7676

@@ -81,21 +81,18 @@ That is,
8181
6. When you are satisfied that the release branch is ready, merge the PR into `main`.
8282

8383
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.
8585

8686
### Automatic Release Process
8787
We use GitHub Actions for automatic release process that responds to pushes of git tags. When a tag matching
8888
a semantic version (`[0-9]+.[0-9]+.[0-9]+*` or `test-release/[0-9]+.[0-9]+.[0-9]+*`) is pushed, the release workflow
8989
runs as follows:
9090

91-
1. Build distribution artifacts for both Anaconda and PyPI distribution.
91+
1. Build distribution artifacts for PyPI.
9292
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.
9996

10097
#### Official Releases
10198
Official releases are published to the public PyPI (even if they are release candidates like `1.2.3rc1`). This differs

pyproject.toml

-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,6 @@ filterwarnings = [
130130
]
131131

132132
# Note: Ruff uses the "nearest" configuration file at runtime so configurations may be overridden
133-
# e.g. see ruff.toml in the tests directory
134133
[tool.ruff]
135134
line-length = 120
136135
extend-include = [

0 commit comments

Comments
 (0)