Skip to content

Conversation

@WilliamBerryiii
Copy link
Member

Description

Configure release-please search depths to prevent version detection failures when the latest release tag is beyond the default commit scanning window. This addresses a known limitation (googleapis/release-please#2267) where release-please fails to find tags older than ~250 commits, causing it to reprocess the entire commit history and incorrectly detect already-released breaking changes.

  • Added release-search-depth: 800 at root level to increase release pagination depth
  • Added commit-search-depth: 1000 at root level to increase commit scanning depth
  • Added include-component-in-tag: true to explicitly match the existing tag format (hve-core-vX.Y.Z)

Related Issue(s)

Related to googleapis/release-please#2267

Type of Change

Select all that apply:

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with prompt-builder agent and addressed all feedback
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)

Note for AI Artifact Contributors:

  • Agents: Research, indexing/referencing other project (using standard VS Code GitHub Copilot/MCP tools), planning, and general implementation agents likely already exist. Review .github/agents/ before creating new ones.
  • Model Versions: Only contributions targeting the latest Anthropic and OpenAI models will be accepted. Older model versions (e.g., GPT-3.5, Claude 3) will be rejected.
  • See Agents Not Accepted and Model Version Requirements.

Other:

  • Script/automation (.ps1, .sh, .py)
  • Other (please describe):

Sample Prompts (for AI Artifact Contributions)

N/A - This is a configuration fix, not an AI artifact contribution.

Testing

  • Validated JSON syntax using node -e "require('./release-please-config.json')"
  • Verified configuration matches the release-please JSON schema (no IDE validation errors)
  • Expected behavior: Next release-please run will correctly detect the v2.0.1 tag regardless of commit distance

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

AI Artifact Contributions

N/A

Required Automated Checks

The following validation commands must pass before merging:

  • Markdown linting: npm run lint:md
  • Spell checking: npm run spell-check
  • Frontmatter validation: npm run lint:frontmatter
  • Link validation: npm run lint:md-links
  • PowerShell analysis: npm run lint:ps

Security Considerations

  • This PR does not contain any sensitive or NDA information
  • Any new dependencies have been reviewed for security issues
  • Security-related scripts follow the principle of least privilege

Additional Notes

This fix addresses the erroneous v3.0.0 release PR (#341) that was created immediately after publishing v2.0.1. The root cause was the 250-commit window limitation causing release-please to reprocess the entire commit history and re-detect the breaking change from PR #277 that was already released in v2.0.0.

🔧 - Generated by Copilot

…it window issue

- add release-search-depth (800) and commit-search-depth (1000) at root level
- add explicit include-component-in-tag setting to match existing tag format

🔧 - Generated by Copilot
@WilliamBerryiii WilliamBerryiii requested a review from a team as a code owner January 29, 2026 02:27
Copilot AI review requested due to automatic review settings January 29, 2026 02:27
@github-actions
Copy link

github-actions bot commented Jan 29, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codecov-commenter
Copy link

codecov-commenter commented Jan 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.43%. Comparing base (b93d990) to head (9048e66).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #342      +/-   ##
==========================================
- Coverage   52.46%   52.43%   -0.04%     
==========================================
  Files          17       17              
  Lines        3084     3084              
==========================================
- Hits         1618     1617       -1     
- Misses       1466     1467       +1     
Flag Coverage Δ
pester 52.43% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes a release-please configuration issue where the tool fails to detect version tags beyond its default ~250 commit scanning window, causing it to incorrectly reprocess the entire commit history and detect already-released breaking changes.

Changes:

  • Added search depth configurations (release-search-depth: 800, commit-search-depth: 1000) to expand release-please's commit scanning window
  • Added explicit tag format configuration (include-component-in-tag: true) to match the existing hve-core-vX.Y.Z tag pattern

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants