Skip to content

Commit

Permalink
ci: rename release channel dev to rc
Browse files Browse the repository at this point in the history
This project employs the use of the [setuptools scm](https://setuptools-scm.readthedocs.io/en/latest/)
plugin during builds to extract package versions from git.
Unfortunately, this plugin forbids tagging dev releases. See this
[comment](pypa/setuptools_scm#213 (comment))
for more details.

This causes issues when building the project outside the CI where
`setuptools_scm` keeps failing when the last tag is a "dev" tag. And
although `setuptools_scm` provides a mechanism to [override the version](https://setuptools-scm.readthedocs.io/en/latest/overrides/#pretend-versions)
at build, this doesn't work when building with `tox`. This is highly
inconvenient as `tox` is handy for running tests and other workflows
such as linting and building docs.

From the problem description above, the solution is to change the
tagging of the dev releases to something else. I pick *rc*(release
candidate), which coincidentally I believe is more appropriate as
changes on the develop branch constitute contents of the next major
release.
  • Loading branch information
kennedykori committed Mar 21, 2024
1 parent 343c7d0 commit 2e18630
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .releaserc.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
branches:
- main
- name: develop
channel: dev
prerelease: dev
channel: rc
prerelease: rc
plugins:
- '@semantic-release/commit-analyzer'
- - '@semantic-release/release-notes-generator'
Expand Down

0 comments on commit 2e18630

Please sign in to comment.