Skip to content

Add script to update changelogs of a release candidate - #3668

Merged
cryptodev-2s merged 8 commits into
mainfrom
feature-auto-update-changelog
Dec 19, 2023
Merged

Add script to update changelogs of a release candidate#3668
cryptodev-2s merged 8 commits into
mainfrom
feature-auto-update-changelog

Conversation

@cryptodev-2s

@cryptodev-2scryptodev-2s commented Dec 14, 2023

Copy link
Copy Markdown
Contributor

Explanation

Add script scripts/update-changelog.sh for updating changelogs of a release candidate

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

@cryptodev-2s
cryptodev-2s requested review from a team as code ownersDecember 14, 2023 15:27
@cryptodev-2scryptodev-2s self-assigned this Dec 14, 2023
@cryptodev-2scryptodev-2s added the team-wallet-framework Deprecated: Please use `team-core-platform` instead. label Dec 14, 2023
@cryptodev-2scryptodev-2s changed the title Feat add script to update changelogs of a release candidateAdd script to update changelogs of a release candidateDec 14, 2023

@mcmiremcmire left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for doing this. We should also make sure to add a Yarn constraint in constraints.pro that enforces that all packages have a changelog:update package script. You should be able to copy the existing one for changelog:validate here: https://github.com/MetaMask/core/blob/main/constraints.pro#L269

Comment threadscripts/update-changelog.sh Outdated
Comment threadscripts/update-changelog.sh Outdated
@cryptodev-2s

Copy link
Copy Markdown
ContributorAuthor

Thanks for doing this. We should also make sure to add a Yarn constraint in constraints.pro that enforces that all packages have a changelog:update package script. You should be able to copy the existing one for changelog:validate here: https://github.com/MetaMask/core/blob/main/constraints.pro#L269

Constraint added, but actually both they only check if it's valid no error is thrown if it doesn't exist

@mcmire

Copy link
Copy Markdown
Collaborator

Oh! Hmm. Alright, I guess we can fix that issue in another PR.

Comment threadpackages/json-rpc-engine/package.json

@mcmiremcmire left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

One fix needed, but this is otherwise good to go!

Comment threadscripts/update-changelog.sh Outdated

@mcmiremcmire left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good!

@cryptodev-2s
cryptodev-2s merged commit da6a302 into mainDec 19, 2023
@cryptodev-2s
cryptodev-2s deleted the feature-auto-update-changelog branch December 19, 2023 23:23
@GudahttGudahtt mentioned this pull request Jul 16, 2025
4 tasks
Gudahtt added a commit that referenced this pull request Jul 17, 2025
Update the template used by the `create-package` script. The previous
template was no longer compatible with our Yarn constraints.
Here are the PRs related to these specific changes:
* #4648
* #3645
* #1390
* #3668
Gudahtt added a commit that referenced this pull request Jul 17, 2025
## Explanation
Update the template used by the `create-package` script. The previous
template was no longer compatible with our Yarn constraints.
## References
Here are the PRs related to these specific changes:
* #4648
* #3645
* #1390
* #3668
## Changelog
N/A
## Checklist
- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team-wallet-frameworkDeprecated: Please use `team-core-platform` instead.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@cryptodev-2s@mcmire@Mrtenz