Skip to content

Commit

Permalink
Correctly format github release. Update README for releasing
Browse files Browse the repository at this point in the history
  • Loading branch information
firecat53 committed Nov 22, 2024
1 parent eb98c12 commit 65a77b3
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
13 changes: 12 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ jobs:
id-token: write # IMPORTANT: mandatory for sigstore

steps:
- name: Check out the repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all tags and history
- name: Get tag annotation
id: tag_annotation
run: |
# Extract the tag annotation for release notes
tag_annotation=$(git for-each-ref --format '%(contents:body)' refs/tags/${{ github.ref_name }})
echo "annotation=$tag_annotation" >> $GITHUB_ENV
- name: Download all the dists
uses: actions/download-artifact@v4
with:
Expand All @@ -88,7 +98,8 @@ jobs:
gh release create
'${{ github.ref_name }}'
--repo '${{ github.repository }}'
--notes ""
--title '${{ github.ref_name }}'
--notes "${{ env.annotation }}"
- name: Upload artifact signatures to GitHub Release
env:
GITHUB_TOKEN: ${{ github.token }}
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ To run tests in a venv: `make test` (not implemented yet)
- Using `nix`:
- `nix develop`: Provides development shell with all dependencies.
- `make test` and `hatch build/publish` work as usual.
- GitHub Action will upload to TestPyPi on each push to `main`. To create a
GitHub and PyPi release, create a new tag (formatting below) and push tags.

<tag name on first line>

* Release note 1
* Release note 2
* ...

## Planned features

Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ classifiers = [
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Utilities",
]
dependencies = [
Expand Down

0 comments on commit 65a77b3

Please sign in to comment.