Skip to content

Commit

Permalink
Add info about release in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Draculente committed Oct 3, 2023
1 parent bfcadf3 commit 4413783
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,16 @@ If you want to, you could also run the service in a docker container put use sys

1. `git clone https://github.com/Draculente/web-command.git`
2. `cd web-command`
3. `cargo build --release`
3. `cargo build --release`

## Release

When you want to create a new release, follow these steps:

1. Update the version in the project's package.json file (e.g. 1.2.3)
1. Commit that change (`git commit -am v1.2.3`)
1. Tag the commit (`git tag v1.2.3`). Make sure your tag name's format is `v*.*.*` The workflow will use this tag to detect when to create a release
1. Push the changes to GitHub (`git push && git push --tags`)
1. Edit and publish the release draft created by the workflow in GitHub

After building successfully, the action will publish the release artifacts in a new release draft that will be created on GitHub with download links for the app.

0 comments on commit 4413783

Please sign in to comment.