Skip to content

ci: add release and PyPI publish workflows #15

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

Merged
obeone merged 2 commits into from
Mar 30, 2026
Merged

ci: add release and PyPI publish workflows #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51d9d39
ci: add release workflow for automatic GitHub releases on tag push
obeone Mar 30, 2026
c442d9a
ci: add PyPI publish workflow on release
obeone Mar 30, 2026
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
32 changes: 32 additions & 0 deletions .github/workflows/publish-pypi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Publish to PyPI

on:
release:
types:
- published

jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.x"

- name: Install build dependencies
run: |
python -m pip install --upgrade pip
pip install build twine

- name: Build package
run: python -m build

- name: Publish to PyPI
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: twine upload dist/*
Comment on lines +10 to +32

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI about 1 month ago

In general, the fix is to add an explicit permissions: block that limits the GITHUB_TOKEN to the minimum access needed. For this workflow, the job only needs to read the repository contents to allow actions/checkout to function; it does not need to push commits, manage releases, or modify pull requests. Therefore, we can safely set contents: read.

The best way to fix this without changing existing functionality is to add a top-level permissions: block (between name: and on:) so that all jobs in the workflow inherit it. This keeps the change minimal and clear. Concretely, in .github/workflows/publish-pypi.yaml, insert:

permissions:
  contents: read

after the first line (name: Publish to PyPI). No additional methods, imports, or definitions are required, since this is just GitHub Actions YAML configuration.

Suggested changeset 1
.github/workflows/publish-pypi.yaml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/publish-pypi.yaml b/.github/workflows/publish-pypi.yaml
--- a/.github/workflows/publish-pypi.yaml
+++ b/.github/workflows/publish-pypi.yaml
@@ -1,5 +1,8 @@
 name: Publish to PyPI
 
+permissions:
+  contents: read
+
 on:
   release:
     types:
EOF
@@ -1,5 +1,8 @@
name: Publish to PyPI

permissions:
contents: read

on:
release:
types:
Copilot is powered by AI and may make mistakes. Always verify output.
27 changes: 27 additions & 0 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Create Release

on:
push:
tags:
- "v[0-9]+.[0-9]+.[0-9]+"

permissions:
contents: write

jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ github.ref_name }}
name: ${{ github.ref_name }}
generate_release_notes: true
draft: false
prerelease: false
Loading