Skip to content

Docs: record native build provenance #11

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
tony merged 1 commit into from
Sep 30, 2026
Merged

Docs: record native build provenance #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
75 changes: 54 additions & 21 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,14 @@ jobs:

build:
needs: identity
runs-on: ubuntu-latest
runs-on: ubuntu-24.04
timeout-minutes: 30
env:
LIBTMUX_DOCS_PORT: lua
LIBTMUX_DOCS_VERSION: ${{ matrix.version }}
LIBTMUX_DOCS_SOURCE_REPOSITORY: ${{ needs.identity.outputs.source-repository }}
LIBTMUX_DOCS_CHECKOUT_LUA: ${{ github.workspace }}/port
LIBTMUX_DOCS_GENERATOR_CHECKOUT: ${{ github.workspace }}/docs-generator
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.identity.outputs.matrix) }}
Expand All @@ -186,9 +193,11 @@ jobs:
repository: ${{ needs.identity.outputs.source-repository }}
ref: ${{ needs.identity.outputs.source-ref }}
fetch-depth: 0
path: port
persist-credentials: false

- id: source
working-directory: port
env:
SELECTED_REF: ${{ needs.identity.outputs.source-ref }}
run: |
Expand All @@ -204,43 +213,50 @@ jobs:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ github.sha }}
path: .docs-generator
path: docs-generator
persist-credentials: false

- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
repository: libtmux/docs
ref: 8fda4b89071621b9ed2c4722a68d61f6ecf9c1c4
path: .site
ref: 42dd5b71e6eefd785b9bf8ce11d34e8f1a058a22
path: docs
persist-credentials: false

- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: '26'

- name: Snapshot source and exporter before native generation
working-directory: docs
env:
LIBTMUX_DOCS_SOURCE_SHA: ${{ steps.source.outputs.sha }}
run: node scripts/publication-provenance.mjs snapshot "$RUNNER_TEMP/build-inputs.json" "$PWD"

- uses: jdx/mise-action@c2a87611a18de5b3828c5652fe268e992400cb5c # v4.3.0
with:
version: 2026.9.9
working_directory: port
cache: false

- name: Bootstrap the pinned LuaLS exporter
run: python .docs-generator/scripts/bootstrap_native.py luals
run: python docs-generator/scripts/bootstrap_native.py luals

- name: Export the selected Lua source
run: |
python .docs-generator/scripts/export-docs \
--source "$GITHUB_WORKSPACE" \
--luals "$GITHUB_WORKSPACE/.docs-generator/.cache/tools/luals-3.19.1/bin/lua-language-server" \
--output "$GITHUB_WORKSPACE/docs/_build"
python docs-generator/scripts/export-docs \
--source "$GITHUB_WORKSPACE/port" \
--luals "$GITHUB_WORKSPACE/docs-generator/.cache/tools/luals-3.19.1/bin/lua-language-server" \
--output "$GITHUB_WORKSPACE/port/docs/_build"

- uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
with:
package_json_file: .site/package.json
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: '26'
cache: pnpm
cache-dependency-path: .site/pnpm-lock.yaml
package_json_file: docs/package.json
- run: pnpm install --frozen-lockfile
working-directory: .site
working-directory: docs

- name: Build the selected Lua documentation tree
working-directory: .site
working-directory: docs
env:
LIBTMUX_DOCS_PORT: lua
LIBTMUX_DOCS_VERSION: ${{ matrix.version }}
Expand All @@ -249,13 +265,30 @@ jobs:
LIBTMUX_DOCS_RESOLVES_TO: ${{ matrix.resolvesTo }}
LIBTMUX_DOCS_SOURCE_REF: ${{ needs.identity.outputs.source-ref }}
LIBTMUX_DOCS_SOURCE_SHA: ${{ steps.source.outputs.sha }}
LIBTMUX_DOCS_CHECKOUT_LUA: ${{ github.workspace }}
LIBTMUX_DOCS_INPUT_SNAPSHOT: ${{ runner.temp }}/build-inputs.json
run: ./scripts/build-site.sh --ports lua --versions "${{ matrix.version }}" --skip-refs --skip-pagefind

- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
- id: content
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: docs-lua-${{ matrix.version }}
path: .site/_site/en/lua/${{ matrix.version }}
path: docs/_site/en/lua/${{ matrix.version }}
if-no-files-found: error
retention-days: 1
include-hidden-files: true

- name: Describe the uploaded artifact
working-directory: docs
env:
ARTIFACT_ID: ${{ steps.content.outputs.artifact-id }}
ARTIFACT_DIGEST: ${{ steps.content.outputs.artifact-digest }}
ARTIFACT_NAME: docs-lua-${{ matrix.version }}
SOURCE_SHA: ${{ steps.source.outputs.sha }}
run: node scripts/publication-provenance.mjs descriptor "$RUNNER_TEMP/publication.json"
- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: docs-lua-${{ matrix.version }}-publication
path: ${{ runner.temp }}/publication.json
if-no-files-found: error
retention-days: 1

Expand All @@ -268,7 +301,7 @@ jobs:
permissions:
contents: read
id-token: write
uses: libtmux/docs/.github/workflows/reusable-deploy.yml@8fda4b89071621b9ed2c4722a68d61f6ecf9c1c4
uses: libtmux/docs/.github/workflows/reusable-deploy.yml@42dd5b71e6eefd785b9bf8ce11d34e8f1a058a22
with:
path-prefix: lua/${{ matrix.version }}
artifact: docs-lua-${{ matrix.version }}
Expand Down
35 changes: 35 additions & 0 deletions tests/tooling/test_docs_workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@


class DocsWorkflowTest(unittest.TestCase):
def workflow(self):
return (ROOT / ".github/workflows/docs.yml").read_text()

def test_preview_publication_uses_the_preview_role(self):
workflow = (ROOT / ".github/workflows/docs.yml").read_text()

Expand All @@ -15,3 +18,35 @@ def test_preview_publication_uses_the_preview_role(self):
"secrets.LIBTMUX_DOCS_ROLE_ARN }}",
workflow,
)

def test_source_exporter_and_docs_use_separate_checkouts(self):
workflow = self.workflow()
for path in ("port", "docs-generator", "docs"):
self.assertIn(f" path: {path}\n", workflow)
self.assertNotIn("path: .site", workflow)
self.assertNotIn("path: .docs-generator", workflow)
self.assertIn("LIBTMUX_DOCS_CHECKOUT_LUA: ${{ github.workspace }}/port", workflow)
self.assertIn("LIBTMUX_DOCS_GENERATOR_CHECKOUT: ${{ github.workspace }}/docs-generator", workflow)
self.assertLess(workflow.index("publication-provenance.mjs snapshot"), workflow.index("Bootstrap the pinned LuaLS exporter"))
self.assertIn('--source "$GITHUB_WORKSPACE/port"', workflow)
self.assertIn('--output "$GITHUB_WORKSPACE/port/docs/_build"', workflow)
self.assertIn("LIBTMUX_DOCS_INPUT_SNAPSHOT: ${{ runner.temp }}/build-inputs.json", workflow)

def test_descriptor_uses_the_exact_content_upload(self):
workflow = self.workflow()
self.assertIn(" - id: content\n uses: actions/upload-artifact@", workflow)
self.assertIn("include-hidden-files: true", workflow)
self.assertIn("ARTIFACT_ID: ${{ steps.content.outputs.artifact-id }}", workflow)
self.assertIn("ARTIFACT_DIGEST: ${{ steps.content.outputs.artifact-digest }}", workflow)
self.assertIn("ARTIFACT_NAME: docs-lua-${{ matrix.version }}", workflow)
self.assertIn("name: docs-lua-${{ matrix.version }}-publication", workflow)
self.assertIn('publication-provenance.mjs descriptor "$RUNNER_TEMP/publication.json"', workflow)
import re
docs = re.search(r"repository: libtmux/docs\n\s+ref: ([0-9a-f]{40})", workflow)
self.assertIsNotNone(docs)
self.assertIn(f"reusable-deploy.yml@{docs[1]}", workflow)

def test_arbitrary_source_builds_do_not_restore_caches(self):
workflow = self.workflow()
self.assertIn("working_directory: port\n cache: false", workflow)
self.assertNotIn("cache: pnpm", workflow)
Loading