Add DoodleBUGS PR Preview cleanup workflow #387
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses issue #342 by adding an automated GitHub Actions workflow to clean up DoodleBUGS PR previews when pull requests are closed or merged.
Problem
Currently, when PRs containing DoodleBUGS changes are created, the
DoodleBUGSpreview.yml
workflow automatically builds and deploys preview sites toDoodleBUGS/pr-previews/{PR_NUMBER}
in the gh-pages branch. However, these preview directories (including all their JavaScript, CSS, and asset files) remain indefinitely after PRs are closed, leading to:Solution
Added a new workflow
.github/workflows/DoodleBUGSPreviewCleanup.yml
that:git rm -rf
actions/checkout@v4
and explicit permissionsKey Features
DoodleBUGS/pr-previews/{PR_NUMBER}
directory and all its contentscontents: write
permissionThe workflow follows the same pattern as the existing
DocsPreviewCleanup.yml
but is specifically tailored for the DoodleBUGS preview structure and includes several improvements like path-based triggering and updated action versions.This ensures that the gh-pages branch stays clean and only contains active preview sites, while automatically removing all associated assets when PRs are closed.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.