Skip to content

Commit ac4e543

Browse files
committed
Add steps to release a beta version
1 parent e260b43 commit ac4e543

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,39 @@ Once the changes are merged on `main`, you can publish the current draft release
116116

117117
GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/meilisearch).
118118

119+
#### Release a `beta` Version
120+
121+
Here are the steps to release a beta version of this package:
122+
123+
- Create a new branch originating the branch containing the "beta" changes. For example, if during the MeiliSearch pre-release, create a branch originating `bump-meilisearch-v*.*.*`.<br>
124+
`vX.X.X` is the next version of the package, NOT the version of MeiliSearch!
125+
126+
```bash
127+
git checkout bump-meilisearch-v*.*.*
128+
git pull origin bump-meilisearch-v*.*.*
129+
git checkout -b vX.X.X-beta.0
130+
```
131+
132+
- Change the version in `package.json` by `vX.X.X-beta.0` and commit it to the `vX.X.X-beta.0` branch
133+
134+
- Go to the [GitHub interface for releasing](https://github.com/meilisearch/meilisearch-js/releases): on this page, click on `Draft a new release`.
135+
136+
- Create a GitHub pre-release:
137+
- Fill the description with the detailed changelogs
138+
- Fill the title with `vX.X.X-beta.0`
139+
- Fill the tag with `vX.X.X-beta.0`
140+
- ⚠️ Select the `vX.X.X-beta.0` branch and NOT `main`
141+
- ⚠️ Click on the "This is a pre-release" checkbox
142+
- Click on "Publish release"
143+
144+
GitHub Actions will be triggered and push the beta version to [npm](https://www.npmjs.com/package/meilisearch).
145+
146+
💡 If you need to release a new beta for the same version (i.e. `vX.X.X-beta.1`):
147+
- merge the change into `bump-meilisearch-v*.*.*`
148+
- rebase the `vX.X.X-beta.0` branch
149+
- change the version name in `package.json`
150+
- creata a pre-release via the GitHub interface
151+
119152
<hr>
120153

121154
Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️

0 commit comments

Comments
 (0)