Skip to content
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

Add a workflow for publishing a release #87

Merged
merged 3 commits into from
Jan 14, 2025
Merged

Conversation

bsweger
Copy link
Collaborator

@bsweger bsweger commented Jan 10, 2025

This workflow is based on the template provided by the Python Packaging Authority:
https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#the-whole-ci-cd-workflow

In addition to publishing to PyPI, the workflow uses the distribution artifacts to create a GitHub release.

After this PR is merged, the release process should look similar to what we do in the Hubverse:

  1. Locally, create a signed, annotated tag for the release version (from the main branch)
  2. Push the tag to remote
  3. The new publish-pypi.yaml workflow will run and publish to PyPI

This workflow is based on the template provided by the
Python Packaging Authority:
https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#the-whole-ci-cd-workflow

In addition to publishing to PyPI, the workflow uses the distribution
artifacts to create a GitHub release.
@bsweger bsweger force-pushed the bs/publish-release/80 branch from 35aff6e to 252bd59 Compare January 13, 2025 16:48
@bsweger bsweger marked this pull request as ready for review January 13, 2025 19:58
@bsweger bsweger requested a review from zkamvar January 13, 2025 20:04
Direct people to install the package from PyPI instead of GitHub
zkamvar
zkamvar previously approved these changes Jan 13, 2025
Copy link
Member

@zkamvar zkamvar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

The only thing hanging is the weird limitation you are giving yourself for tags given that you only have 7 minor versions left 😱

.github/workflows/publish-pypi.yaml Outdated Show resolved Hide resolved
Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
@bsweger bsweger merged commit 8edda6b into main Jan 14, 2025
3 checks passed
@bsweger bsweger deleted the bs/publish-release/80 branch January 14, 2025 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants