github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-05-06 07:01:45 -05:00
Code Issues 1.5k Packages Projects Releases 54 Wiki Activity

[PR #6793] [CLOSED] Skip AI-generated release notes for documentation-only PRs #36937

New Issue
Closed
opened 2026-04-20 23:45:40 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-20 23:45:40 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/6793
Author: @Copilot
Created: 1/27/2026
Status: ❌ Closed

Base: master ← Head: copilot/fix-release-notes-bot-behavior

📝 Commits (3)

  • e3b6ccb Initial plan
  • d363a63 Add docs-only PR detection to ai-generated-release-notes workflow
  • 11b3717 Add release notes for PR #6793

📊 Changes

2 files changed (+37 additions, -5 deletions)

View changed files

📝 .github/workflows/ai-generated-release-notes.yml (+31 -5)
➕ upcoming-release-notes/6793.md (+6 -0)

📄 Description

The ai-generated-release-notes workflow was generating release notes for documentation-only PRs (e.g., PR #6585). These PRs don't require release notes per project guidelines.

Changes

  • Added docs-only detection step after branch check:

    • Fetches PR files via GitHub API
    • Filters for non-docs paths (excludes packages/docs/, .github/actions/docs-spelling/)
    • Sets only_docs=true when all files are documentation

  • Updated conditional guards on all downstream steps:

    • Check release notes existence
    • OpenAI summary generation
    • Category determination
    • File creation and PR comment

    All now include: steps.check-docs-only.outputs.only_docs != 'true'

Implementation

- name: Check if PR only modifies documentation
  run: |
    CHANGED_FILES=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
      "https://api.github.com/repos/${{ github.repository }}/pulls/$PR_NUMBER/files" | \
      jq -r '.[].filename')
    
    NON_DOCS_FILES=$(echo "$CHANGED_FILES" | grep -v -e "^packages/docs/" -e "^\.github/actions/docs-spelling/" || true)
    
    if [ -z "$NON_DOCS_FILES" ] && [ -n "$CHANGED_FILES" ]; then
      echo "only_docs=true" >> $GITHUB_OUTPUT
    fi

Follows existing pattern in release-notes.yml workflow (lines 18-30) for consistency.

Original prompt

This section details on the original issue you should resolve

<issue_title>Bot incorrectly generates release notes comments and commits for docs-only PRs</issue_title>
<issue_description>## Issue Description

The bot is currently requesting generating release notes for documentation-only pull requests. According to project guidelines, docs-only PRs should not require auto-generate release notes.

Context

This issue was identified in PR actualbudget/actual#6585 (https://github.com/actualbudget/actual/pull/6585), which only modifies documentation files.

Expected Behavior

The bot should skip the release notes requirement for PRs that only modify documentation files.

Reported By

@MatissJanis

References

<agent_instructions>Update the github workflow that generates release notes files from coderabbitai summaries. We want to disable this workflow if the changes are only done in "packages/docs" since these changes do not require a release notes file.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/6793 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 1/27/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `copilot/fix-release-notes-bot-behavior` --- ### 📝 Commits (3) - [`e3b6ccb`](https://github.com/actualbudget/actual/commit/e3b6ccb4aba12834ac0c76c5b9918ed9f3c8f1e2) Initial plan - [`d363a63`](https://github.com/actualbudget/actual/commit/d363a6395da8e9f1ddd82fb71302b3ac53b21380) Add docs-only PR detection to ai-generated-release-notes workflow - [`11b3717`](https://github.com/actualbudget/actual/commit/11b3717afe813bb3f9e8938db701c09308a61477) Add release notes for PR #6793 ### 📊 Changes **2 files changed** (+37 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/ai-generated-release-notes.yml` (+31 -5) ➕ `upcoming-release-notes/6793.md` (+6 -0) </details> ### 📄 Description The `ai-generated-release-notes` workflow was generating release notes for documentation-only PRs (e.g., PR #6585). These PRs don't require release notes per project guidelines. ## Changes - **Added docs-only detection step** after branch check: - Fetches PR files via GitHub API - Filters for non-docs paths (excludes `packages/docs/`, `.github/actions/docs-spelling/`) - Sets `only_docs=true` when all files are documentation - **Updated conditional guards** on all downstream steps: - Check release notes existence - OpenAI summary generation - Category determination - File creation and PR comment All now include: `steps.check-docs-only.outputs.only_docs != 'true'` ## Implementation ```yaml - name: Check if PR only modifies documentation run: | CHANGED_FILES=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ "https://api.github.com/repos/${{ github.repository }}/pulls/$PR_NUMBER/files" | \ jq -r '.[].filename') NON_DOCS_FILES=$(echo "$CHANGED_FILES" | grep -v -e "^packages/docs/" -e "^\.github/actions/docs-spelling/" || true) if [ -z "$NON_DOCS_FILES" ] && [ -n "$CHANGED_FILES" ]; then echo "only_docs=true" >> $GITHUB_OUTPUT fi ``` Follows existing pattern in `release-notes.yml` workflow (lines 18-30) for consistency. <!-- START COPILOT ORIGINAL PROMPT --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>Bot incorrectly generates release notes comments and commits for docs-only PRs</issue_title> > <issue_description>## Issue Description > > The bot is currently ~requesting~ generating release notes for documentation-only pull requests. According to project guidelines, docs-only PRs should not ~require~ auto-generate release notes. > > ## Context > > This issue was identified in PR actualbudget/actual#6585 (https://github.com/actualbudget/actual/pull/6585), which only modifies documentation files. > > ## Expected Behavior > > The bot should skip the release notes requirement for PRs that only modify documentation files. > > ## Reported By > > @MatissJanis > > ## References > > - PR: https://github.com/actualbudget/actual/pull/6585 > - Comment: https://github.com/actualbudget/actual/pull/6585#issuecomment</issue_description> > > <agent_instructions>Update the github workflow that generates release notes files from coderabbitai summaries. We want to disable this workflow if the changes are only done in "packages/docs" since these changes do not require a release notes file.</agent_instructions> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> <!-- START COPILOT CODING AGENT SUFFIX --> - Fixes actualbudget/actual#6586 <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/actualbudget/actual/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-20 23:45:40 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#36937
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?