Skip to content

Commit 056ec9e

Browse files
authored
Merge pull request #58 from Couchbase-Ecosystem/chore/update-contributing-release-checklist
chore: add release checklist for contributing
2 parents 42a291c + 2303866 commit 056ec9e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,19 @@ We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint]
121121

122122
Our pre-commit hooks verify that the linter and tests pass when committing.
123123

124+
## How to Release the project
125+
126+
### Release Checklist
127+
- [ ] Update the version in `package.json`, and commit this change to main.
128+
- [ ] Build the project using `npm run build`.
129+
- [ ] Write release notes, and add them to a new [GitHub release](https://github.com/Couchbase-Ecosystem/cbl-reactnative/releases) (under a tag that corresponds to the new version number).
130+
- [ ] Publish the release notes to the [cbl-reactnative.dev](https://cbl-reactnative.dev) website by updating [this file](https://github.com/Couchbase-Ecosystem/cbl-reactnative-docs/blob/main/docs/ProductNotes/release-notes.md).
131+
- [ ] Publish the package to npm using `npm publish` (or `npm release` if using release-it).
132+
124133
### Publishing to npm
125134

135+
**Note: currently release-it requires some secrets, and the most recent releases have been done manually, via `npm publish`. In the future, we'd like to use release-it, but for the time being manual publish seems to work the best.**
136+
126137
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
127138

128139
To publish new versions, run the following:

0 commit comments

Comments
 (0)