Skip to content

Commit

Permalink
Correctly enter github release title/notes and update README for rele…
Browse files Browse the repository at this point in the history
…ase process
  • Loading branch information
firecat53 committed Nov 22, 2024
1 parent a418d6b commit 7c55eb3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
9 changes: 8 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,21 @@ jobs:
inputs: >-
./dist/*.tar.gz
./dist/*.whl
- 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: Create GitHub Release
env:
GITHUB_TOKEN: ${{ github.token }}
run: >-
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
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,6 @@ The follow actions are supported:
- `top` -- move to first list item (default: `g`)
- `up` -- cursor up (default: `k`)

## Update TLD list (for developers, not users)

`wget https://data.iana.org/TLD/tlds-alpha-by-domain.txt`

## Known bugs and limitations

- Running urlscan sometimes "messes up" the terminal background. This seems to
Expand All @@ -215,6 +211,15 @@ The follow actions are supported:
- pyproject.toml is configured for [hatch][2] for building and submitting to pypi.
- flake.nix is available for a development shell or building/testing the package
if desired. `nix develop`
- To update TLD list: `wget https://data.iana.org/TLD/tlds-alpha-by-domain.txt`
- 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
* ...

[1]: http://urwid.org/manual/displayattributes.html#display-attributes "Urwid display attributes"
[2]: https://hatch.pypa.io/latest/ "Hatch"

0 comments on commit 7c55eb3

Please sign in to comment.