diff --git a/README.md b/README.md index 130806b4..0c65348a 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,31 @@ yarn start --sources packages/esm-form-entry-app ## Contributing -Contributions are welcome. Please read through the [technical roadmap](https://github.com/openmrs/openmrs-ngx-formentry/issues/1) first to see what features are planned for the library. +Contributions are welcome. Please read through the [technical roadmap](https://github.com/openmrs/openmrs-ngx-formentry/issues/1) first to see what features are planned for the library. Read through our [Contributing Guidelines](https://o3-docs.openmrs.org/docs/frontend-modules/contributing) to get a better understanding of how to contribute. + +## Cutting a new release + +To cut a new release, start by creating a release branch: + +```sh +git checkout -b chore/release-vX.Y.Z +``` + +Then update the version in the `package.json` file: + +```sh +yarn version --new-version --no-git-tag-version +``` + +Commit the change and push it to the repository: + +```sh +git add . +git commit -m '(chore) Release vX.Y.Z' +git push +``` + +Then create a pull request and merge it into the `main` branch. Once the PR is merged, create a new release in the GitHub releases UI and publish it. This should run the [release](https://github.com/openmrs/openmrs-ngx-formentry/blob/main/.github/workflows/main.yml#L97-L98) job in our main CI workflow. Once the job completes successfully, the new release will be published to NPM and will automatically appear on our [Changelog page](https://o3-docs.openmrs.org/docs/changelog) in the docs. ## Credits diff --git a/package.json b/package.json index 7947268b..b845bc45 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@openmrs/ngx-formentry", - "version": "5.0.0", + "version": "5.1.0", "license": "MPL-2.0", "scripts": { "ng": "ng",