Skip to content

Commit 65a77b3

Browse files
committed
Correctly format github release. Update README for releasing
1 parent eb98c12 commit 65a77b3

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

.github/workflows/main.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,16 @@ jobs:
7070
id-token: write # IMPORTANT: mandatory for sigstore
7171

7272
steps:
73+
- name: Check out the repository
74+
uses: actions/checkout@v4
75+
with:
76+
fetch-depth: 0 # Fetch all tags and history
77+
- name: Get tag annotation
78+
id: tag_annotation
79+
run: |
80+
# Extract the tag annotation for release notes
81+
tag_annotation=$(git for-each-ref --format '%(contents:body)' refs/tags/${{ github.ref_name }})
82+
echo "annotation=$tag_annotation" >> $GITHUB_ENV
7383
- name: Download all the dists
7484
uses: actions/download-artifact@v4
7585
with:
@@ -88,7 +98,8 @@ jobs:
8898
gh release create
8999
'${{ github.ref_name }}'
90100
--repo '${{ github.repository }}'
91-
--notes ""
101+
--title '${{ github.ref_name }}'
102+
--notes "${{ env.annotation }}"
92103
- name: Upload artifact signatures to GitHub Release
93104
env:
94105
GITHUB_TOKEN: ${{ github.token }}

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,14 @@ To run tests in a venv: `make test` (not implemented yet)
9494
- Using `nix`:
9595
- `nix develop`: Provides development shell with all dependencies.
9696
- `make test` and `hatch build/publish` work as usual.
97+
- GitHub Action will upload to TestPyPi on each push to `main`. To create a
98+
GitHub and PyPi release, create a new tag (formatting below) and push tags.
99+
100+
<tag name on first line>
101+
102+
* Release note 1
103+
* Release note 2
104+
* ...
97105

98106
## Planned features
99107

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ classifiers = [
3131
"Programming Language :: Python :: 3.9",
3232
"Programming Language :: Python :: 3.10",
3333
"Programming Language :: Python :: 3.11",
34+
"Programming Language :: Python :: 3.12",
35+
"Programming Language :: Python :: 3.13",
3436
"Topic :: Utilities",
3537
]
3638
dependencies = [

0 commit comments

Comments
 (0)