Skip to content

Commit

Permalink
publish instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
luiztauffer committed Sep 11, 2024
1 parent 0dbd3ac commit 7cb0def
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,10 @@ npm run build:linux
Publishing will happen every time a new push is maded to the `main` branch with a tag associated, creating a release at [release page](https://github.com/catalystneuro/vame-desktop/releases).

To avoid unecessary releases, follow these steps:
- create a branch `git checkout -b <branch_name>`, work on it, and create a pull request once the job is done.
- create a new tag with `git tag v<tag_number>`, push it to the repo with `git push orgin --tags`.
- merge the PR from `<branch_name>` into `main`. The github actions will create a [Draft Release](https://github.com/catalystneuro/vame-desktop/releases) where you can manually add extra info, and finaly approve and publish.
- Create a branch `git checkout -b <branch_name>`, work on it, and create a pull request to `main`.
- Update the `package.json` with the new version number.
- Create a new tag with `git tag v<tag_number>`, push it to the repo with `git push orgin --tags`. **IMPORTANT**: the tag must be in the format `vX.Y.Z` where `X.Y.Z` is the package version number in `package.json`.
- Merge the PR from `<branch_name>` into `main`. The github actions will create a [Draft Release](https://github.com/catalystneuro/vame-desktop/releases).
- Manually edit the draft release, add information about the new features, bug fixes, and breaking changes.
- Finaly approve and publish the new release.

0 comments on commit 7cb0def

Please sign in to comment.