[PR #6815] [MERGED] Skip release notes generation for docs-only PRs #41186

Closed
opened 2026-04-23 13:59:02 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/6815
Author: @StephenBrown2
Created: 1/29/2026
Status: Merged
Merged: 4/15/2026
Merged by: @matt-fidd

Base: masterHead: skip-docs-release-notes


📝 Commits (3)

  • 61e94de Skip release notes generation for docs-only PRs
  • e2dee81 Merge branch 'master' into skip-docs-release-notes
  • 40fd5d4 Merge branch 'master' into skip-docs-release-notes

📊 Changes

3 files changed (+48 additions, -9 deletions)

View changed files

📝 .github/actions/ai-generated-release-notes/pr-details.js (+37 -0)
📝 .github/workflows/ai-generated-release-notes.yml (+5 -9)
upcoming-release-notes/6815.md (+6 -0)

📄 Description

Summary

This PR prevents the automatic generation of release notes for documentation-only pull requests.

Fixes #6586

What

  • Extended pr-details.js to detect docs-only PRs by checking if all changed files are in packages/docs/
  • Added pagination support to handle PRs with more than 100 changed files
  • Added a consolidated eligibility check in the workflow that combines base branch and docs-only validation
  • Simplified step conditions to reduce redundancy by having each step only check its immediate dependency

Why

Documentation-only PRs don't need release notes since they don't affect the application functionality. Generating release notes for these PRs creates unnecessary noise in the changelog and extra work for maintainers to review/remove them.

How

  1. The pr-details.js script fetches all changed files (with pagination via octokit.paginate) and sets isDocsOnly: true if all files are under packages/docs/
  2. A new "Check if PR qualifies for release notes" step evaluates both the target branch (must be master) and the docs-only flag
  3. If eligible=false, all subsequent release notes generation steps are naturally skipped due to cascading conditions

AI Generated

Yes, this PR was created with AI prompts.


🔄 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/6815 **Author:** [@StephenBrown2](https://github.com/StephenBrown2) **Created:** 1/29/2026 **Status:** ✅ Merged **Merged:** 4/15/2026 **Merged by:** [@matt-fidd](https://github.com/matt-fidd) **Base:** `master` ← **Head:** `skip-docs-release-notes` --- ### 📝 Commits (3) - [`61e94de`](https://github.com/actualbudget/actual/commit/61e94de23ab4a5653d54830281e27d2444f54519) Skip release notes generation for docs-only PRs - [`e2dee81`](https://github.com/actualbudget/actual/commit/e2dee816d2a500fad662f00bd7b61010be9844e6) Merge branch 'master' into skip-docs-release-notes - [`40fd5d4`](https://github.com/actualbudget/actual/commit/40fd5d49882135cb77e4b9f5efc6f46b112bf79d) Merge branch 'master' into skip-docs-release-notes ### 📊 Changes **3 files changed** (+48 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `.github/actions/ai-generated-release-notes/pr-details.js` (+37 -0) 📝 `.github/workflows/ai-generated-release-notes.yml` (+5 -9) ➕ `upcoming-release-notes/6815.md` (+6 -0) </details> ### 📄 Description ## Summary This PR prevents the automatic generation of release notes for documentation-only pull requests. Fixes #6586 ## What - Extended `pr-details.js` to detect docs-only PRs by checking if all changed files are in `packages/docs/` - Added pagination support to handle PRs with more than 100 changed files - Added a consolidated eligibility check in the workflow that combines base branch and docs-only validation - Simplified step conditions to reduce redundancy by having each step only check its immediate dependency ## Why Documentation-only PRs don't need release notes since they don't affect the application functionality. Generating release notes for these PRs creates unnecessary noise in the changelog and extra work for maintainers to review/remove them. ## How 1. The `pr-details.js` script fetches all changed files (with pagination via `octokit.paginate`) and sets `isDocsOnly: true` if all files are under `packages/docs/` 2. A new "Check if PR qualifies for release notes" step evaluates both the target branch (must be master) and the docs-only flag 3. If `eligible=false`, all subsequent release notes generation steps are naturally skipped due to cascading conditions ### AI Generated Yes, this PR was created with AI prompts. --- <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-23 13:59:02 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#41186