From 22ab03fbbc384152924f69569a04e692781c38e2 Mon Sep 17 00:00:00 2001 From: Infinite Red CI Date: Mon, 13 May 2024 18:27:23 +0000 Subject: [PATCH] orb(react-native-mlkit): bump to republish docs (351662edb302e10aabc0376a70867eda2d00ee45) --- .../changesets-versions-and-releases.md | 36 +++++++++++++++---- 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/docs/react-native-mlkit/contributing/changesets-versions-and-releases.md b/docs/react-native-mlkit/contributing/changesets-versions-and-releases.md index b87151ba..cf5beb21 100644 --- a/docs/react-native-mlkit/contributing/changesets-versions-and-releases.md +++ b/docs/react-native-mlkit/contributing/changesets-versions-and-releases.md @@ -4,17 +4,34 @@ sidebar_position: 99 # Changesets, Versions, and Releases -## Using Changesets in the Repository +## Steps for Contribution and Release + +As this is a monorepo with many packages that depend on one another, we use an automated system to manage versioning and +releases. + +The good news is most of this is automated for you! here is a quick overview of the process: + +1. **Make Changes**: Implement your feature or bug fix in your branch. +2. **Include a Changeset**: Necessary for all changes requiring a version bump. Run `yarn changeset` to generate one. +3. **Open a PR against main**: Automated tests and builds will verify your changes. +4. **Merge the PR**: Via GitHub Actions `changesets` checks for version bumps and automatically creates a "Version + Packages" PR against main +5. **Merging the "Version Packages" PR to Publish Packages**: Merging the Version Packages PR triggers our automated + NPM publishing process. + +## Using Changesets Changesets is a tool we use to manage versioning and changelogs in our monorepo efficiently. It allows us to track -changes to the packages within the repository, ensuring that when we release updates, all dependent packages are -versioned correctly, and their changelogs are updated appropriately. +changes to the packages, ensuring that when we release updates, all dependent packages are versioned correctly, and +their changelogs are updated appropriately. ### Getting Started with Changesets -To introduce a change or a new feature that you believe should trigger a version update of a package (or packages), -you'll need to create a changeset. A changeset is essentially a record of what packages need to be released and how ( -major, minor, or patch). +When you open a PR with a change or a new feature that you believe should trigger a version update of a package (or +packages), +you'll need to include a changeset in your PR. + +A changeset is essentially a record of what packages need to be released and how (major, minor, or patch). 1. **Creating a Changeset** @@ -28,11 +45,18 @@ major, minor, or patch). or patch). It will then generate a `.md` file in the `.changeset` directory describing these changes. Include this file in your pull request. + :::tip + It shouldn't be necessary to manually edit the changeset file. + ::: + 2. **Reviewing Changesets in PRs** Changesets included in pull requests are reviewed as part of the code review process. This ensures that the versioning and changelogs will accurately reflect the changes once merged. + As a reviewer, be on the lookout for changes in PRs that will require version bumps and ensure they are included + when necessary. + 3. **Releasing Changes** Our release process is automated through GitHub Actions and utilizes the custom `release` script defined in