@@ -106,7 +106,26 @@ $ mv signature.rs src/pb_signature.rs
106106
107107## Release Process
108108
109- - Merge PRs into `master`.
110- - Update version in `Cargo.toml`, `action.yml`, `Dockerfile`, and GitHub Actions configurations.
111- - Create release branch (e.g., `release-1.0.0`) and tag (e.g., `v1.0.0`).
112- - Update [Homebrew repo](https://github.com/Screenly/homebrew-screenly-cli) with the latest version.
109+ This project follows [Semantic Versioning](https://semver.org/) (M.m.p = Major.minor.patch).
110+
111+ 1. **Prepare the release:**
112+ - Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`). This is just a suggestion; you can name the branch as you prefer.
113+ - Update version in `Cargo.toml`, `action.yml`, and `Dockerfile`
114+ - Run `cargo build` to update `Cargo.lock` with the new version. This step is optional but recommended.
115+
116+ 2. **Create and merge the pull request:**
117+ - Create a pull request from the release branch to `master`
118+ - Once approved, merge the pull request
119+
120+ 3. **Create the GitHub release:**
121+ - Make sure that you' re on the ` master` branch and have pulled the latest changes
122+ - Create a version tag (e.g., ` vM.m.p` , like ` v1.0.h6` ) and push it to GitHub by running:
123+ ` ` ` bash
124+ git tag vM.m.p
125+ git push origin vM.m.p
126+ ```
127+ - The release workflow will detect the version tag and create the release automatically
128+ - Add the release notes to the GitHub release description
129+
130+ 4. ** Update Homebrew:**
131+ - Update the [Homebrew repo](https://github.com/Screenly/homebrew-screenly-cli) with the latest version
0 commit comments