fix(ci): cleanup PLAN files in a separate PR, add to comment, not description #7029
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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 | ||||
|---|---|---|---|---|---|---|
| @@ -1,9 +1,17 @@ | ||||||
| # Cleanup Ephemeral Planning Documents | ||||||
| # | ||||||
| # This workflow automatically removes PLAN.md and other ephemeral planning | ||||||
| # documents from the main branch. It serves as a safety net in case the | ||||||
| # /finish skill wasn't used before merging. | ||||||
| # | ||||||
| # Triggers: | ||||||
| # 1. pull_request_target (closed+merged) - catches files merged via PR | ||||||
| # 2. push to main branches - catches files pushed directly or via squash | ||||||
| # merge (path-filtered to only run when ephemeral files are present) | ||||||
| # | ||||||
| # Strategy: Creates a cleanup PR instead of pushing directly to the | ||||||
| # protected main branch, since branch protection rules block direct pushes. | ||||||
| # | ||||||
| # Ephemeral documents are temporary files used during development that | ||||||
| # shouldn't persist on the main branch: | ||||||
| # - PLAN.md: Planning and task tracking | ||||||
|
|
@@ -12,16 +20,14 @@ | |||||
| # These files are tracked on feature branches but should be deleted before | ||||||
| # merge. If they slip through, this action cleans them up. | ||||||
| # | ||||||
| # The "Preserve plan details" step only runs for PR merges (not direct | ||||||
| # pushes) since there's no source PR to comment on for direct pushes. | ||||||
| # | ||||||
| # Security Note: Uses pull_request_target to ensure write permissions for | ||||||
| # PRs from forks. This is safe because: | ||||||
| # 1. The workflow only checks out the base branch (not PR code) | ||||||
| # 2. File paths are validated (hardcoded list of allowed files) | ||||||
| # 3. No PR-controlled code is executed | ||||||
|
|
||||||
| name: Cleanup ephemeral docs | ||||||
|
|
||||||
|
|
@@ -31,11 +37,20 @@ on: | |||||
| branches: | ||||||
| - master | ||||||
| - main | ||||||
| push: | ||||||
| branches: | ||||||
| - master | ||||||
| - main | ||||||
| paths: | ||||||
| - 'PLAN.md' | ||||||
| - 'HANDOVER.md' | ||||||
|
|
||||||
| jobs: | ||||||
| cleanup: | ||||||
| # Run when PR is merged OR when ephemeral files are pushed directly | ||||||
| if: >- | ||||||
| (github.event_name == 'push') || | ||||||
| (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true) | ||||||
| runs-on: ubuntu-latest | ||||||
|
|
||||||
| permissions: | ||||||
|
|
@@ -46,21 +61,24 @@ jobs: | |||||
| - name: Checkout repository | ||||||
| uses: actions/checkout@v4 | ||||||
| with: | ||||||
| ref: ${{ github.event.pull_request.base.ref || github.ref }} | ||||||
| fetch-depth: 0 | ||||||
|
|
||||||
| - name: Check for ephemeral files | ||||||
| id: check | ||||||
| run: | | ||||||
| FILES_TO_REMOVE="" | ||||||
| FILE_LIST="" | ||||||
|
|
||||||
| if [ -f "PLAN.md" ]; then | ||||||
| FILES_TO_REMOVE="$FILES_TO_REMOVE PLAN.md" | ||||||
| FILE_LIST="${FILE_LIST:+$FILE_LIST, }PLAN.md" | ||||||
| echo "Found: PLAN.md" | ||||||
| fi | ||||||
|
|
||||||
| if [ -f "HANDOVER.md" ]; then | ||||||
| FILES_TO_REMOVE="$FILES_TO_REMOVE HANDOVER.md" | ||||||
| FILE_LIST="${FILE_LIST:+$FILE_LIST, }HANDOVER.md" | ||||||
| echo "Found: HANDOVER.md" | ||||||
| fi | ||||||
|
|
||||||
|
|
@@ -71,67 +89,84 @@ jobs: | |||||
| echo "Files to remove:$FILES_TO_REMOVE" | ||||||
| echo "has_files=true" >> $GITHUB_OUTPUT | ||||||
| echo "files=$FILES_TO_REMOVE" >> $GITHUB_OUTPUT | ||||||
| echo "file_list=$FILE_LIST" >> $GITHUB_OUTPUT | ||||||
| fi | ||||||
|
|
||||||
| - name: Preserve plan details on source PR | ||||||
| if: >- | ||||||
| steps.check.outputs.has_files == 'true' && | ||||||
| github.event_name == 'pull_request_target' | ||||||
| env: | ||||||
| GH_TOKEN: ${{ github.token }} | ||||||
| run: | | ||||||
| PR_NUMBER=${{ github.event.pull_request.number }} | ||||||
|
|
||||||
| if [ -f "PLAN.md" ]; then | ||||||
| gh pr comment "$PR_NUMBER" --body "$(cat <<'EOFCOMMENT' | ||||||
| ## Development Plan (preserved by cleanup workflow) | ||||||
|
|
||||||
| Full plan details from `PLAN.md`, preserved before automated cleanup: | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| EOFCOMMENT | ||||||
| cat PLAN.md)" | ||||||
| echo "Posted PLAN.md contents to PR #$PR_NUMBER" | ||||||
| fi | ||||||
|
|
||||||
| if [ -f "HANDOVER.md" ]; then | ||||||
| gh pr comment "$PR_NUMBER" --body "$(cat <<'EOFCOMMENT' | ||||||
| ## Handover Notes (preserved by cleanup workflow) | ||||||
|
|
||||||
| Full contents from `HANDOVER.md`, preserved before automated cleanup: | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| EOFCOMMENT | ||||||
| cat HANDOVER.md)" | ||||||
|
Comment on lines
123
to
+126
There was a problem hiding this comment. Same heredoc indentation issue as above: the |
||||||
| echo "Posted HANDOVER.md contents to PR #$PR_NUMBER" | ||||||
| fi | ||||||
|
|
||||||
| - name: Create cleanup PR | ||||||
| if: steps.check.outputs.has_files == 'true' | ||||||
| env: | ||||||
| GH_TOKEN: ${{ github.token }} | ||||||
| run: | | ||||||
| TARGET_BRANCH="${{ github.event.pull_request.base.ref || github.ref_name }}" | ||||||
| CLEANUP_BRANCH="chore/cleanup-ephemeral-docs-$(date +%Y%m%d-%H%M%S)" | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| git config user.name "github-actions[bot]" | ||||||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||||||
|
|
||||||
| # Create cleanup branch from current HEAD | ||||||
| git checkout -b "$CLEANUP_BRANCH" | ||||||
|
|
||||||
| # Remove ephemeral files | ||||||
| git rm -f ${{ steps.check.outputs.files }} | ||||||
|
|
||||||
| git commit -m "chore: remove ephemeral planning docs [skip ci] | ||||||
|
|
||||||
| Automated cleanup of development planning documents. | ||||||
| These files are used during development but shouldn't | ||||||
| persist on the main branch. | ||||||
|
|
||||||
| Files removed: ${{ steps.check.outputs.file_list }}" | ||||||
|
|
||||||
| git push -u origin "$CLEANUP_BRANCH" | ||||||
|
|
||||||
| # Create PR and auto-merge | ||||||
| PR_URL=$(gh pr create \ | ||||||
| --base "$TARGET_BRANCH" \ | ||||||
| --head "$CLEANUP_BRANCH" \ | ||||||
| --title "chore: remove ephemeral planning docs" \ | ||||||
| --body "Automated cleanup of development planning documents (${{ steps.check.outputs.file_list }}). | ||||||
|
|
||||||
| These files are used during development but shouldn't persist on the main branch. | ||||||
| Created by the cleanup-ephemeral-docs workflow.") | ||||||
|
|
||||||
| echo "Created cleanup PR: $PR_URL" | ||||||
|
|
||||||
| # Enable auto-merge so it merges once checks pass | ||||||
| gh pr merge "$PR_URL" --auto --squash --delete-branch || echo "Auto-merge not available, PR requires manual merge" | ||||||
|
|
||||||
| echo "Cleanup PR created and auto-merge enabled" | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heredoc used to build the PR comment body is indented, so the
EOFCOMMENTterminator won’t be recognized by bash (heredoc delimiters must start at column 1 unless using<<-with tabs). This will cause the step to hang or fail and prevent plan preservation. Consider left-aligning the terminator line (no leading whitespace) or avoid heredocs here (e.g., useprintf/catwithout heredoc).