Skip to content

Commit

Permalink
docs: add CI workflow to cleanup leftover files from push previews
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Strömer committed Jun 3, 2024
1 parent 362db51 commit 6e4f903
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/DocPreviewCleanup.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# See: https://documenter.juliadocs.org/stable/man/hosting/#Cleaning-up-gh-pages
# for more information on why and how to use this workflow.

name: DocPreviewCleanup

on:
pull_request:
types: [closed]

concurrency:
group: doc-preview-cleanup
cancel-in-progress: false

jobs:
doc-preview-cleanup:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout gh-pages branch
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Delete preview and history + push changes
run: |
if [ -d "${preview_dir}" ]; then
git config user.name "Documenter.jl"
git config user.email "documenter@juliadocs.github.io"
git rm -rf "${preview_dir}"
git commit -m "delete preview"
git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
git push --force origin gh-pages-new:gh-pages
fi
env:
preview_dir: previews/PR${{ github.event.number }}

0 comments on commit 6e4f903

Please sign in to comment.