Publish a New Release
DASCore’s version comes from git tags; do not edit a version file.
Prepare and publish
- Confirm the documentation builds locally or on a PR labeled
documentation. - Open Draft a new release.
- Choose the next
v*tag using the version policy. - Assemble notes from merged PR
## Changelogsections. Use Breaking Changes, Added, Changed, Deprecated, Removed, Fixed, and Security, omitting empty sections. Repeat breaking entries in Breaking Changes and end each entry with its PR number. - Publish the release to create the tag. GitHub Actions publishes PyPI distributions and builds the docs from that tag.
GitHub can generate a draft, and the repository’s dascore-draft-release agent skill can collect entries, but maintainers must verify the version, target, categories, and wording.
Pre-releases
For alpha, beta, or release-candidate builds:
- Target the branch containing the code, usually
dev; GitHub otherwise defaults tomaster. - Use a PEP 440 tag such as
v0.2.0a1,v0.2.0b1, orv0.2.0rc1. - Select Set as a pre-release, which keeps GitHub from marking it the latest release. The docs workflow treats a release as a pre-release when this is set or when the tag is not a plain
vX.Y.Z, and then leaves the stable docs alone. - Do not publish the pre-release to conda-forge’s main channel.
State how to install it (pip install --pre dascore==0.2.0b1), that it is unavailable on conda-forge, where to report problems, and what breaks relative to the last stable release. The docs workflow builds the docs, attaches docs.zip, and publishes them to dascore.netlify.app rather than dascore.org. That site holds the latest pre-release’s docs; to publish a docs fix between pre-releases, run BuildDeployDevDocs manually from dev.
Verify and recover
Confirm these workflows succeed:
PublishPackage: uploads distributions to PyPI.BuildDeployStableDocs: builds docs, attachesdocs.zip, and deploys stable releases to dascore.org and pre-releases to dascore.netlify.app.
Then verify PyPI and, for stable releases, dascore.org. For pre-releases, verify dascore.netlify.app instead.
Release jobs check out the tag, so reruns use the same commit after its branch advances. Re-run a transient docs job as needed. Re-run PublishPackage only when nothing reached PyPI: PyPI never permits reusing a filename, even after deletion, so partial uploads or source fixes require a new tag. Never move a public tag.
Conda-forge
After a stable version reaches PyPI, check dascore-feedstock for the bot’s update PR or open a “bot commands” issue titled @conda-forge-admin, please update version. Verify its requirements against pyproject.toml, merge it, and confirm the package appears on conda-forge.
The feedstock may include useful optional dependencies unless their slow conda release cadence blocks DASCore releases.