Skip to content

ci(release): create GitHub releases on tag push, drop release-drafter #42

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.

Sign up for GitHub

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

Open
ykdojo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ci(release): create GitHub releases on tag push, drop release-drafter #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 0 additions & 77 deletions .github/release-drafter.yml
View file
Open in desktop

This file was deleted.

8 changes: 8 additions & 0 deletions .github/workflows/publish-package.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ jobs:
environment: ${{ github.event_name == 'workflow_dispatch' && inputs.test-pypi && 'testpypi' || 'pypi' }}
permissions:
id-token: write
# to create the GitHub release for the tag
contents: write
steps:
- uses: actions/checkout@v4
with:
Expand All @@ -35,3 +37,9 @@ jobs:
- name: Publish to PyPI
if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && !inputs.test-pypi)
uses: pypa/gh-action-pypi-publish@release/v1

- name: Create GitHub release with generated notes
if: github.event_name == 'push'
env:
GH_TOKEN: ${{ github.token }}
run: gh release create "$GITHUB_REF_NAME" --generate-notes --verify-tag
36 changes: 0 additions & 36 deletions .github/workflows/release-drafter.yml
View file
Open in desktop

This file was deleted.

13 changes: 9 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,12 @@ conversion.
Versions are derived from git tags via `hatch-vcs`. Tag releases as `v0.1.0`,
`v0.2.0`, etc.

Publishing a GitHub release triggers `.github/workflows/publish-package.yml`,
which builds a wheel and sdist with `uv build` and uploads both to PyPI via
[trusted publishing](https://docs.pypi.org/trusted-publishers/). Configure the
trusted publisher on PyPI for this repository before the first release.
Pushing a `v*` tag triggers `.github/workflows/publish-package.yml`, which
builds a wheel and sdist with `uv build`, uploads both to PyPI via
[trusted publishing](https://docs.pypi.org/trusted-publishers/), and creates a
GitHub release for the tag with auto-generated notes. To cut a release:

```
git tag v0.X.0 <main-sha>
git push origin v0.X.0
```
Loading