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

Update creating partial release documentation #1741

Closed
xinnanyemm opened this issue Sep 28, 2023 · 1 comment · Fixed by #3592
Closed

Update creating partial release documentation #1741

xinnanyemm opened this issue Sep 28, 2023 · 1 comment · Fixed by #3592
Assignees

Comments

@xinnanyemm
Copy link

xinnanyemm commented Sep 28, 2023

Update the create-release-branch version in the core monorepo, and update the core monorepo contributor documentation to include updated workflow changes and recommendations related to recent changes to that tool.

For example:

  • Encourage contributors to minimize the number of packages in each release, where it's safe to do so
  • Explain how to deal with common errors
  • Update the docs to explain the updated workflow for updating the release changelog
@xinnanyemm
Copy link
Author

@Gudahtt Gudahtt transferred this issue from MetaMask/contributor-docs Sep 28, 2023
cryptodev-2s added a commit that referenced this issue Dec 7, 2023
## Explanation

This PR updates the release process to take in considerations recent
changes on create-release-branch.
- Compel users to release packages with breaking changes alongside their
dependents [MetaMask/create-release-branch#101]
- Compel users to release new versions of dependencies alongside their
dependents [MetaMask/create-release-branch#102]
- Reorder workflow to update changelogs first
[MetaMask/create-release-branch#109]

## References

- Closes #1741

## 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 highlighted breaking changes using the "BREAKING" category
above as appropriate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants