Skip to content

Commit

Permalink
docs: update release section
Browse files Browse the repository at this point in the history
  • Loading branch information
cedoor committed May 20, 2024
1 parent 650d5a3 commit 25943b7
Showing 1 changed file with 6 additions and 22 deletions.
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,30 +221,14 @@ yarn docs

The output will be placed on the `docs` folder.

## Releases
### 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:
Bump a new version for your package with:

```bash
git push origin <version>
# e.g. git push origin 2.0.0
yarn version:bump <package-name> <version>
# e.g. yarn version:bump utils 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.
It will create a commit and a git tag that you'll need to push on the main branch. A workflow will be triggered and will
publish your package on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically.

0 comments on commit 25943b7

Please sign in to comment.