Skip to content

ci: misc improvements #1024

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
merged 3 commits into from
Jan 12, 2025
Merged

ci: misc improvements #1024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce1aec8
ci: pre-commit cache + uv cache everywhere
mkniewallner Jan 12, 2025
2f73e87
ci(release): dry-run more things
mkniewallner Jan 12, 2025
326cea3
ci(release): use `github.ref_name` for tag
mkniewallner Jan 12, 2025
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
15 changes: 13 additions & 2 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ jobs:
uses: astral-sh/setup-uv@v5
with:
version: ${{ env.UV_VERSION }}
enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install Python
uses: actions/setup-python@v5
Expand All @@ -40,8 +42,14 @@ jobs:
- name: Setup Rust toolchain
run: rustup component add clippy rustfmt

- name: Load pre-commit cache
uses: actions/cache@v4
with:
path: ~/.cache/pre-commit
key: pre-commit-${{ env.PYTHON_VERSION }}-${{ hashFiles('.pre-commit-config.yaml') }}

- name: Run pre-commit
run: uvx pre-commit@${PRE_COMMIT_VERSION} run -a --show-diff-on-failure
run: uvx pre-commit@${PRE_COMMIT_VERSION} run --all-files --show-diff-on-failure
env:
# renovate: datasource=pypi depName=pre-commit
PRE_COMMIT_VERSION: '4.0.1'
Expand Down Expand Up @@ -73,7 +81,8 @@ jobs:
uses: astral-sh/setup-uv@v5
with:
version: ${{ env.UV_VERSION }}
enable-cache: 'true'
enable-cache: true
cache-dependency-glob: "uv.lock"
cache-suffix: ${{ matrix.python-version }}

- name: Install Python
Expand Down Expand Up @@ -112,6 +121,8 @@ jobs:
uses: astral-sh/setup-uv@v5
with:
version: ${{ env.UV_VERSION }}
enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install Python
uses: actions/setup-python@v5
Expand Down
32 changes: 22 additions & 10 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,12 @@ jobs:
with:
persist-credentials: false

- name: Export tag
id: vars
run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
if: ${{ github.event_name == 'release' }}

- name: Update project version
if: ${{ github.event_name == 'release' }}
run: |
sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
env:
RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
if: ${{ github.event_name == 'release' }}
RELEASE_VERSION: ${{ github.ref_name }}
Copy link
Collaborator Author

@mkniewallner mkniewallner Jan 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context

This basically takes the tag name in our usage, taken from refs/tags/<tag>.


- name: Upload updated pyproject.toml
uses: actions/upload-artifact@v4
Expand Down Expand Up @@ -187,8 +182,11 @@ jobs:
publish:
name: Publish
runs-on: ubuntu-24.04
needs: [linux, windows, macos, sdist]
if: ${{ github.event_name == 'release' }}
needs:
- linux
- windows
- macos
- sdist
steps:
- uses: actions/download-artifact@v4

Expand All @@ -198,19 +196,26 @@ jobs:
python-version: ${{ env.PYTHON_VERSION }}

- name: Publish to PyPI
if: ${{ github.event_name == 'release' }}
uses: PyO3/maturin-action@v1
env:
MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
with:
command: upload
args: --non-interactive --skip-existing wheels-*/*

- name: '[dry-run] Publish to PyPI'
if: ${{ github.event_name != 'release' }}
uses: PyO3/maturin-action@v1
with:
command: upload
args: --help

publish-docs:
runs-on: ubuntu-24.04
needs: publish
permissions:
contents: write
if: ${{ github.event_name == 'release' }}
steps:
- name: Check out
uses: actions/checkout@v4
Expand All @@ -219,11 +224,18 @@ jobs:
uses: astral-sh/setup-uv@v5
with:
version: ${{ env.UV_VERSION }}
enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install Python
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}

- name: Deploy documentation
if: ${{ github.event_name == 'release' }}
run: uv run --only-group docs mkdocs gh-deploy --force

- name: '[dry-run] Deploy documentation'
if: ${{ github.event_name != 'release' }}
run: uv run --only-group docs mkdocs gh-deploy --help
2 changes: 1 addition & 1 deletion zizmor.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ rules:
artipacked:
ignore:
# Required for publishing documentation to `gh-pages` branch.
- release.yml:215
- release.yml:220