这是indexloc提供的服务，不要输入任何密码
Skip to content

Use a composite action for docs pushes #34

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 2 commits into from
Jul 30, 2025
Merged

Use a composite action for docs pushes #34

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
8f2eb40
Use a composite action for docs pushes.
Maegereg Jul 29, 2025
b0e3f56
Add project to the commit message.
Maegereg Jul 30, 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
57 changes: 57 additions & 0 deletions .github/actions/push_docs/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: 'Push Docs'
description: 'Build the docs in the current repository, and push it to another.'
inputs:
docs-repository:
description: The organization/name of the docs repository.
required: true
docs-repository-token:
description: A token that grants read/write access to the docs repository.
required: true
docs-path:
description: The path to the current set of docs (e.g. core vs analytics) within the docs repository.
required: true
version:
description: The version of the docs to push to.
required: true
dry-run:
description: If true, pushes to a new branch rather than the default branch.
required: false
default: false
runs:
using: composite
steps:
- name: Get commit
id: commit
run: echo "COMMIT=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
shell: bash
- run: uv run nox -s docs
shell: bash
- run: rm -r public/.doctrees
shell: bash
- name: Checkout docs repository
uses: actions/checkout@v4
with:
repository: ${{ inputs.docs-repository }}
token: ${{ inputs.docs-repository-token }}
path: docs-repo
- run: rm -r docs-repo/${{ inputs.docs-path }}/${{ inputs.version }}
shell: bash
- run: mv public docs-repo/${{ inputs.docs-path }}/${{ inputs.version }}
shell: bash
- name: update version information
working-directory: docs-repo
run: python update-versions.py ${{ inputs.docs-path }}/
shell: bash
- name: commit to docs repo
working-directory: docs-repo
env:
COMMIT: ${{ steps.commit.outputs.COMMIT}}
run: |
git config user.name "docs-bot"
git config user.email "87283505+opendp-dev@users.noreply.github.com"
git config --global push.autoSetupRemote true
if [ ${{ inputs.dry-run }} ]; then git checkout -b dry-run/$COMMIT; fi
git add ${{ inputs.docs-path }}
git commit -m "[auto] Publish docs for ${{ inputs.docs-path }} version ${{ inputs.version }} ($COMMIT)"
git push
shell: bash
32 changes: 7 additions & 25 deletions .github/workflows/commit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
branches:
- 'main'


env:
# Force nox to produce colorful logs:
FORCE_COLOR: "true"
Expand Down Expand Up @@ -40,29 +41,10 @@ jobs:
with:
name: dist
path: dist
- name: Get commit
id: commit
run: echo "COMMIT=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
- run: uv run nox -s docs
- run: rm -r public/.doctrees
- name: Checkout docs repository
uses: actions/checkout@v4
- name: Push docs
uses: ./.github/actions/push_docs
with:
repository: 'opendp/tumult-docs'
token: ${{ secrets.DOCS_REPO_PAT}}
path: tumult-docs
- run: rm -r tumult-docs/docs/analytics/dev
- run: mv public tumult-docs/docs/analytics/dev
- name: update version information
working-directory: tumult-docs
run: python update-versions.py docs/analytics/
- name: commit to docs repo
working-directory: tumult-docs
env:
COMMIT: ${{ steps.commit.outputs.COMMIT}}
run: |
git config user.name "docs-bot"
git config user.email "87283505+opendp-dev@users.noreply.github.com"
git add docs/analytics
git commit -m "[auto] Publish docs for dev ($COMMIT)"
git push
docs-repository: opendp/tumult-docs
docs-repository-token: ${{ secrets.DOCS_REPO_PAT }}
docs-path: docs/analytics
version: dev