Skip to content

Commit

Permalink
Review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
charliermarsh committed Jul 15, 2024
1 parent d5a4d00 commit ca17064
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
18 changes: 7 additions & 11 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ on:
jobs:
mkdocs:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
env:
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
steps:
Expand All @@ -39,7 +36,7 @@ jobs:
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 versioned docs without a version!"
echo "Can't build docs without a version."
exit 1
fi
Expand Down Expand Up @@ -90,22 +87,24 @@ jobs:
git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs
- name: "Copy docs"
run: rm -rf astral-docs/site/uv && mkdir -p astral-docs/site && cp -r site/uv astral-docs/site/uv
run: rm -rf astral-docs/site/uv && mkdir -p astral-docs/site && cp -r site/uv astral-docs/site/

- name: "Commit docs"
working-directory: astral-docs
run: |
branch_name="${{ env.branch_name }}"
git config user.name "GitHub Actions Bot"
git config user.email "github-actions-bot@example.com"
git config user.name "$GITHUB_ACTOR"
git config user.email "[email protected].com"
git checkout -b $branch_name
git add uv
git add site/uv
git commit -m "Update uv 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 }}"
Expand All @@ -123,9 +122,6 @@ jobs:
# push the branch to GitHub
git push origin $branch_name
# authenticate with GitHub
echo ${{ secrets.ASTRAL_DOCS_PAT}} | gh auth login --with-token
# create the PR
gh pr create --base main --head $branch_name \
--title "$pull_request_title" \
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ flamegraph.svg
perf.data
perf.data.old
profile.json

# MkDocs
site

0 comments on commit ca17064

Please sign in to comment.