Skip to content

fix(release): drop package-name from release-please config#328

Merged
ar3s3ru merged 1 commit intomainfrom
fix/release-please-package-name
Apr 21, 2026
Merged

fix(release): drop package-name from release-please config#328
ar3s3ru merged 1 commit intomainfrom
fix/release-please-package-name

Conversation

@ar3s3ru
Copy link
Copy Markdown
Collaborator

@ar3s3ru ar3s3ru commented Apr 21, 2026

Summary

Removes package-name from release-please-config.json. This field was triggering an upstream release-please bug that left merged release PRs stuck in autorelease: pending and prevented tag/GitHub-Release creation.

Root cause

With include-component-in-tag: false (as we have configured), release-please's PR-creation leg correctly uses an empty component. But its PR-parsing leg — used during buildReleases to decide whether to cut a tag — ignores that flag and falls through to getBranchComponent(), which returns the package-name value ("go-eventually"). The configured component ("go-eventually") is then compared against the component parsed from the branch name (`release-please--branches--main`), which is `undefined`. Mismatch → early return → no tag.

This is the upstream bug tracked at googleapis/release-please#2214, open since Feb 2024.

Evidence from the stuck workflow run

Run #24731049954 (post-merge of #327) logged:

```
⚠ PR component: undefined does not match configured component: go-eventually
```

and then:

```
⚠ There are untagged, merged release PRs outstanding - aborting
```

The tag v0.4.0 was never created even though PR #327 was merged successfully.

Fix

Remove package-name — it provides no value here:

  • We don't use components in tags (include-component-in-tag: false).
  • There's no version-file to write the package name into.
  • The tag name is always the bare vMAJOR.MINOR.PATCH at repo root.

With package-name gone, getBranchComponent() returns '', which matches the empty component parsed from the release branch name, and buildReleases no longer bails.

Recovery for the stuck v0.4.0

The stalled v0.4.0 tag will be created manually (separately from this PR) by tagging commit 5e41a02026adf5f4d585aa4b93b9a47bf3326c3f and flipping PR #327's label from autorelease: pendingautorelease: tagged. After that, this config fix ensures the next release cycle (v0.4.1 for this commit) tags automatically when its release PR is merged.

The combination of package-name + include-component-in-tag: false
causes release-please to bail at tag-creation time because the
configured component ("go-eventually") doesn't match the empty
component parsed from the branch name. See upstream issue
googleapis/release-please#2214.

Symptoms: merged release PRs stay labelled 'autorelease: pending'
and no tag/release is cut, because buildReleases() returns early at
src/strategies/base.ts with the warning:

  "PR component: undefined does not match configured component:
   go-eventually"

Since this is a single-module repo with no version file, package-name
provided no value (the tag is already just vX.Y.Z at root) and only
risked leaving merged release PRs stuck.
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.64%. Comparing base (5e41a02) to head (7cce3dc).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #328   +/-   ##
=======================================
  Coverage   63.64%   63.64%           
=======================================
  Files          38       38           
  Lines        1400     1400           
=======================================
  Hits          891      891           
  Misses        447      447           
  Partials       62       62           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@ar3s3ru ar3s3ru merged commit 6ae1f8e into main Apr 21, 2026
8 checks passed
@ar3s3ru ar3s3ru deleted the fix/release-please-package-name branch April 21, 2026 15:38
@github-actions github-actions Bot mentioned this pull request Apr 21, 2026
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.

1 participant