Skip to content
This repository was archived by the owner on Feb 22, 2026. It is now read-only.

RELEASE.md

Latest commit

 

History

History
40 lines (30 loc) · 2.78 KB

RELEASE.md

File metadata and controls

40 lines (30 loc) · 2.78 KB

General Overview

Minor version release

The release process of new minor version consists of the following steps:

  1. Bump version in package.json to the new version v{MAJOR}.{MINOR}.0.
  2. Update version tags in packages/react-native-executorch/src/constants/modelUrls.ts to point to the proper MINOR version and update tags on 🤗 huggingface.
  3. Commit with a message 'Release v{MAJOR}.{MINOR}.0'. (We want to keep the latest MINOR version on the main branch.)
  4. Create a new branch release branch release/{MAJOR}.{MINOR}and push it to the remote.
  5. Stability tests are performed on the release branch and all fixes to the new-found issues are pushed into the main branch and cherry-picked into the release branch. This allows for further development on the main branch without interfering with the release process.
  6. Once all tests are passed, tag the release branch with proper version tag v{MAJOR}.{MINOR}.0 and run npm publish.
  7. Create versioned docs by running from repo root (cd docs && yarn docusaurus docs:version {MAJOR}.{MINOR}.x) (the 'x' part is intentional and is not to be substituted).
  8. Create a PR with the updated docs.
  9. Create the release notes on GitHub.
  10. Update README.md with release video, if available.
  11. Update README.md links to release branch.

Patch release

After the release branch is created and the version is published to npm we only allow for bug fixes and other critical changes to be included into the release branch. For this purpose we use git cherry-pick command.

Caution

Those changes should NOT include documentation changes, as they would be released automatically on the PR's merge and before the code changes are live. Instead create a separate PR with doc changes according to the Docs update section.

  1. Create a PR to the main branch.
  2. Once the PR is merged, cherry-pick the commit to the release branch.
  3. Bump version in package.json to the new version v{MAJOR}.{MINOR}.{REVISION}. Commit with a message 'Release v{MAJOR}.{MINOR}.0'.
  4. Tag release branch with proper version tag v{MAJOR}.{MINOR}.{REVISION} and run npm publish.
  5. Create release notes on GitHub.

Docs update

We are using docusaurus with docs versioning. By default when merging PRs with docs changes to the main branch, a GitHub workflow is started to publish the docs. For this reason those changes should be merged only once the related changes are released. When updating docs the following steps should be considered.

  1. Update the desired doc pages.
  2. Check if the changes are applicable to past versions, if so make the same updates to the correct files in versioned docs inside react-native-executorch/docs/versioned_docs/version-{MAJOR}.{MINOR}.x.
  3. Create a PR to the main branch.