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

Open
opened 2026-02-28 21:32:16 -06:00 by GiteaMirror · 0 comments
Owner

Original Pull Request: https://github.com/actualbudget/actual/pull/6815

State: open
Merged: No


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.

**Original Pull Request:** https://github.com/actualbudget/actual/pull/6815 **State:** open **Merged:** No --- ## 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.
GiteaMirror added the pull-request label 2026-02-28 21:32:16 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#6755