-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add release steps to readme file
- Loading branch information
1 parent
6ce04b5
commit f1bfce4
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,31 @@ | ||
# Semaphore Extensions | ||
|
||
Semaphore Tools and Extensions Monorepo. | ||
|
||
## Releases | ||
|
||
Steps: | ||
|
||
1. Bump a new version with: | ||
|
||
```bash | ||
yarn version:bump <version> | ||
# e.g. yarn version:bump 2.0.0 | ||
``` | ||
|
||
This step creates a commit and a git tag. | ||
|
||
2. Push the changes to main: | ||
|
||
```bash | ||
git push origin main | ||
``` | ||
|
||
3. Push the new git tag: | ||
|
||
```bash | ||
git push origin <version> | ||
# e.g. git push origin 2.0.0 | ||
``` | ||
|
||
After pushing the new git tag, a workflow will be triggered and will publish the Bandada packages on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically. |