Skip to content

Commit

Permalink
docs: try to fix the site (#466)
Browse files Browse the repository at this point in the history
  • Loading branch information
woodruffw authored Jan 18, 2025
1 parent ee00aee commit ce19ed5
Show file tree
Hide file tree
Showing 5 changed files with 894 additions and 5 deletions.
16 changes: 14 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:

- uses: Swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2

- uses: astral-sh/setup-uv@887a942a15af3a7626099df99e897a18d9e5ab3a # v5.1.0
- uses: astral-sh/setup-uv@b5f58b2abc5763ade55e4e9d0fe52cd1ff7979ca # v5.2.1

- name: Test
run: cargo test
Expand All @@ -43,9 +43,21 @@ jobs:
make snippets
git diff --exit-code
test-site:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
persist-credentials: false

- uses: astral-sh/setup-uv@b5f58b2abc5763ade55e4e9d0fe52cd1ff7979ca # v5.2.1

- name: Test site
run: make site

all-tests-pass:
if: always()
needs: [lint, test]
needs: [lint, test, test-site]
runs-on: ubuntu-latest

steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
persist-credentials: false

- name: Install the latest version of uv
uses: astral-sh/setup-uv@887a942a15af3a7626099df99e897a18d9e5ab3a # v3
uses: astral-sh/setup-uv@b5f58b2abc5763ade55e4e9d0fe52cd1ff7979ca # v5.2.1

- name: build site
run: make site
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ all:

.PHONY: site
site:
uv run --no-project --only-group docs mkdocs build
uv run --only-group docs mkdocs build

.PHONY: site-live
site-live:
uv run --no-project --only-group docs mkdocs serve
uv run --only-group docs mkdocs serve

.PHONY: snippets
snippets: trophies sponsors
Expand Down
8 changes: 8 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
requires = ["maturin>=1.0,<2.0"]
build-backend = "maturin"

# NOTE: This section is a stub; needed to prevent
# `uv run --only-group docs` from failing.
[project]
name = "zizmor"
dynamic = ["version"]
# Arbitrarily set to the oldest non-EOL Python.
requires-python = ">=3.9"

[tool.maturin]
bindings = "bin"

Expand Down
Loading

0 comments on commit ce19ed5

Please sign in to comment.