mirror of https://github.com/astral-sh/uv
chore(ci): address findings in publish-docs workflow (#15018)
This commit is contained in:
parent
0b3c32c15b
commit
34b5afcba6
|
|
@ -17,24 +17,28 @@ on:
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
mkdocs:
|
mkdocs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
env:
|
env:
|
||||||
|
VERSION: ${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }}
|
||||||
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
|
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
with:
|
with:
|
||||||
ref: ${{ inputs.ref }}
|
ref: ${{ inputs.ref }}
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
||||||
with:
|
with:
|
||||||
python-version: 3.12
|
python-version: 3.12
|
||||||
|
|
||||||
- name: "Set docs version"
|
- name: "Set docs display name"
|
||||||
run: |
|
run: |
|
||||||
version="${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }}"
|
version="${VERSION}"
|
||||||
# if version is missing, use 'latest'
|
# if version is missing, use 'latest'
|
||||||
if [ -z "$version" ]; then
|
if [ -z "$version" ]; then
|
||||||
echo "Using 'latest' as version"
|
echo "Using 'latest' as version"
|
||||||
|
|
@ -44,21 +48,20 @@ jobs:
|
||||||
# Use version as display name for now
|
# Use version as display name for now
|
||||||
display_name="$version"
|
display_name="$version"
|
||||||
|
|
||||||
echo "version=$version" >> $GITHUB_ENV
|
echo "DISPLAY_NAME=$display_name" >> $GITHUB_ENV
|
||||||
echo "display_name=$display_name" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- name: "Set branch name"
|
- name: "Set branch name"
|
||||||
run: |
|
run: |
|
||||||
version="${{ env.version }}"
|
version="${VERSION}"
|
||||||
display_name="${{ env.display_name }}"
|
display_name="${DISPLAY_NAME}"
|
||||||
timestamp="$(date +%s)"
|
timestamp="$(date +%s)"
|
||||||
|
|
||||||
# create branch_display_name from display_name by replacing all
|
# create branch_display_name from display_name by replacing all
|
||||||
# characters disallowed in git branch names with hyphens
|
# characters disallowed in git branch names with hyphens
|
||||||
branch_display_name="$(echo "$display_name" | tr -c '[:alnum:]._' '-' | tr -s '-')"
|
branch_display_name="$(echo "$display_name" | tr -c '[:alnum:]._' '-' | tr -s '-')"
|
||||||
|
|
||||||
echo "branch_name=update-docs-$branch_display_name-$timestamp" >> $GITHUB_ENV
|
echo "BRANCH_NAME=update-docs-$branch_display_name-$timestamp" >> $GITHUB_ENV
|
||||||
echo "timestamp=$timestamp" >> $GITHUB_ENV
|
echo "TIMESTAMP=$timestamp" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: "Add SSH key"
|
- name: "Add SSH key"
|
||||||
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }}
|
if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }}
|
||||||
|
|
@ -84,8 +87,10 @@ jobs:
|
||||||
|
|
||||||
- name: "Clone docs repo"
|
- name: "Clone docs repo"
|
||||||
run: |
|
run: |
|
||||||
version="${{ env.version }}"
|
version="${VERSION}"
|
||||||
git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs
|
git clone https://${ASTRAL_DOCS_PAT}@github.com/astral-sh/docs.git astral-docs
|
||||||
|
env:
|
||||||
|
ASTRAL_DOCS_PAT: ${{ secrets.ASTRAL_DOCS_PAT }}
|
||||||
|
|
||||||
- name: "Copy docs"
|
- name: "Copy docs"
|
||||||
run: rm -rf astral-docs/site/uv && mkdir -p astral-docs/site && cp -r site/uv astral-docs/site/
|
run: rm -rf astral-docs/site/uv && mkdir -p astral-docs/site && cp -r site/uv astral-docs/site/
|
||||||
|
|
@ -93,7 +98,7 @@ jobs:
|
||||||
- name: "Commit docs"
|
- name: "Commit docs"
|
||||||
working-directory: astral-docs
|
working-directory: astral-docs
|
||||||
run: |
|
run: |
|
||||||
branch_name="${{ env.branch_name }}"
|
branch_name="${BRANCH_NAME}"
|
||||||
|
|
||||||
git config user.name "astral-docs-bot"
|
git config user.name "astral-docs-bot"
|
||||||
git config user.email "176161322+astral-docs-bot@users.noreply.github.com"
|
git config user.email "176161322+astral-docs-bot@users.noreply.github.com"
|
||||||
|
|
@ -107,9 +112,9 @@ jobs:
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }}
|
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }}
|
||||||
run: |
|
run: |
|
||||||
version="${{ env.version }}"
|
version="${VERSION}"
|
||||||
display_name="${{ env.display_name }}"
|
display_name="${DISPLAY_NAME}"
|
||||||
branch_name="${{ env.branch_name }}"
|
branch_name="${BRANCH_NAME}"
|
||||||
|
|
||||||
# set the PR title
|
# set the PR title
|
||||||
pull_request_title="Update uv documentation for $display_name"
|
pull_request_title="Update uv documentation for $display_name"
|
||||||
|
|
@ -135,7 +140,7 @@ jobs:
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }}
|
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }}
|
||||||
run: |
|
run: |
|
||||||
branch_name="${{ env.branch_name }}"
|
branch_name="${BRANCH_NAME}"
|
||||||
|
|
||||||
# auto-merge the PR if the build was triggered by a release. Manual builds should be reviewed by a human.
|
# 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
|
# give the PR a few seconds to be created before trying to auto-merge it
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue