Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release candidate should be created even if updateChangelog does not return any new entries #138

Closed
MajorLift opened this issue Jun 27, 2024 · 0 comments · Fixed by #139
Closed
Assignees
Labels
bug Something isn't working team-wallet-framework

Comments

@MajorLift
Copy link

Currently, the create-release-pr action is terminated with an error message ("updateChangelog" returned an empty value for package ...) and the release candidate is not created if the updateChangelog call does not return any new entries.

Presumably, the original intention for this behavior was to prevent a release candidate from being created if there are no new commits or changelog entries to be included in a new release.

However, the Wallet Framework Team is trialing a new practice of recording changelog entries under the "unreleased" heading. Because of this, all of the new commits may already have corresponding entries under the "unreleased" heading (which will have been migrated to the new release's heading by updateChangelog). This will result in a situation where there are new commits to be released, but updateChangelog still returns a null value.

Therefore, the error "updateChangelog" returned an empty value for package ... should be triggered only if both of the following are true:

  • updateChangelog returns a null value.
  • There are no unreleased changes present in the changelog.

The updateChangelog implementation @metamask/auto-changelog has a variable that could be used for this: hasUnreleasedChangesToRelease.

@MajorLift MajorLift added the bug Something isn't working label Jun 27, 2024
MajorLift added a commit to MetaMask/superstruct that referenced this issue Jun 27, 2024
- `create-release-pr` action is failing due to this issue:
MetaMask/action-create-release-pr#138
- Removing unreleased changelog entries should unblock this, enabling a
release candidate to be created.
@kanthesha kanthesha self-assigned this Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working team-wallet-framework
Projects
None yet
2 participants