-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
30cef67
commit 48baa62
Showing
1 changed file
with
98 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,42 +21,131 @@ jobs: | |
mkdocs: | ||
runs-on: ubuntu-latest | ||
env: | ||
CF_API_TOKEN_EXISTS: ${{ secrets.CF_API_TOKEN != '' }} | ||
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
ref: ${{ inputs.ref }} | ||
|
||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.12 | ||
|
||
- name: "Set docs version" | ||
run: | | ||
version="${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }}" | ||
# if version is missing, exit with error | ||
if [[ -z "$version" ]]; then | ||
echo "Can't build docs without a version." | ||
exit 1 | ||
fi | ||
# Use version as display name for now | ||
display_name="$version" | ||
echo "version=$version" >> $GITHUB_ENV | ||
echo "display_name=$display_name" >> $GITHUB_ENV | ||
- name: "Set branch name" | ||
run: | | ||
version="${{ env.version }}" | ||
display_name="${{ env.display_name }}" | ||
timestamp="$(date +%s)" | ||
# create branch_display_name from display_name by replacing all | ||
# characters disallowed in git branch names with hyphens | ||
branch_display_name="$(echo "$display_name" | tr -c '[:alnum:]._' '-' | tr -s '-')" | ||
echo "branch_name=update-docs-$branch_display_name-$timestamp" >> $GITHUB_ENV | ||
echo "timestamp=$timestamp" >> $GITHUB_ENV | ||
- name: "Add SSH key" | ||
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | ||
uses: webfactory/[email protected] | ||
with: | ||
ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} | ||
|
||
- name: "Install Rust toolchain" | ||
run: rustup show | ||
|
||
- uses: Swatinem/rust-cache@v2 | ||
|
||
- name: "Install Insiders dependencies" | ||
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | ||
run: pip install -r docs/requirements-insiders.txt | ||
|
||
- name: "Install dependencies" | ||
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} | ||
run: pip install -r docs/requirements.txt | ||
|
||
- name: "Copy README File" | ||
run: | | ||
python scripts/transform_readme.py --target mkdocs | ||
python scripts/generate_mkdocs.py | ||
- name: "Build Insiders docs" | ||
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | ||
run: mkdocs build --strict -f mkdocs.insiders.yml | ||
|
||
- name: "Build docs" | ||
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} | ||
run: mkdocs build --strict -f mkdocs.public.yml | ||
- name: "Deploy to Cloudflare Pages" | ||
if: ${{ env.CF_API_TOKEN_EXISTS == 'true' }} | ||
uses: cloudflare/[email protected] | ||
with: | ||
apiToken: ${{ secrets.CF_API_TOKEN }} | ||
accountId: ${{ secrets.CF_ACCOUNT_ID }} | ||
# `github.head_ref` is only set during pull requests and for manual runs or tags we use `main` to deploy to production | ||
command: pages deploy site --project-name=astral-docs --branch ${{ github.head_ref || 'main' }} --commit-hash ${GITHUB_SHA} | ||
|
||
- name: "Clone docs repo" | ||
run: | | ||
version="${{ env.version }}" | ||
git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs | ||
- name: "Copy docs" | ||
run: rm -rf astral-docs/site/ruff && mkdir -p astral-docs/site && cp -r site/ruff astral-docs/site/ | ||
|
||
- name: "Commit docs" | ||
working-directory: astral-docs | ||
run: | | ||
branch_name="${{ env.branch_name }}" | ||
git config user.name "$GITHUB_ACTOR" | ||
git config user.email "[email protected]" | ||
git checkout -b $branch_name | ||
git add site/ruff | ||
git commit -m "Update ruff documentation for $version" | ||
- name: "Create Pull Request" | ||
working-directory: astral-docs | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }} | ||
run: | | ||
version="${{ env.version }}" | ||
display_name="${{ env.display_name }}" | ||
branch_name="${{ env.branch_name }}" | ||
# set the PR title | ||
pull_request_title="Update ruff documentation for $display_name" | ||
# Delete any existing pull requests that are open for this version | ||
# by checking against pull_request_title because the new PR will | ||
# supersede the old one. | ||
gh pr list --state open --json title --jq '.[] | select(.title == "$pull_request_title") | .number' | \ | ||
xargs -I {} gh pr close {} | ||
# push the branch to GitHub | ||
git push origin $branch_name | ||
# create the PR | ||
gh pr create --base main --head $branch_name \ | ||
--title "$pull_request_title" \ | ||
--body "Automated documentation update for $display_name" \ | ||
--label "documentation" | ||
- name: "Merge Pull Request" | ||
if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }} | ||
working-directory: astral-docs | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }} | ||
run: | | ||
branch_name="${{ env.branch_name }}" | ||
# auto-merge the PR if the build was triggered by a release. Manual builds should be reviewed by a human. | ||
# give the PR a few seconds to be created before trying to auto-merge it | ||
sleep 10 | ||
gh pr merge --squash $branch_name |