Skip to content

Commit

Permalink
docs: describe PR-based release process (#52)
Browse files Browse the repository at this point in the history
Signed-off-by: Miroslav Bajtoš <saturn@bajtos.net>
  • Loading branch information
bajtos committed Jul 26, 2022
1 parent 2a8e92a commit dcd883b
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,30 @@ Filecoin Station uses [electron-build/auto-update](https://www.electron.build/au

<!-- TODO: manual tag creation could be automated -->

1. Update `electron*` dependencies, if necessary.
2. Commit the changes.
3. Create a new feature branch, e.g. `release/A.B.C`
4. Update the package version using `npm --no-git-tag-version version A.B.C`
5. Commit the changes, use `release: vA.B.C` as the commit message
6. Open a pull request, wait for CI to finish, and then land the PR.
7. Pull the latest `main` branch to your machine, create a new tag and push it to GitHub:

```
git checkout main
git pull
git tag -a -s vA.B.C
# Set the commit message to "vA.B.C"
git push origin vA.B.C
```

3. Wait for GitHub Actions CI to upload the binaries to a draft release [here](https://github.com/filecoin-project/filecoin-station/releases) (a new one will be created if you haven't drafted one).
4. Review and publish the release draft.
- Once a release is published, users will receive the app update
- The `latest.yml, latest-mac.yml, latest-linux.yml` files attached to [/releases](https://github.com/filecoin-project/filecoin-station/releases) are used by the desktop app to determine when an app update is available.
5. Done!

### Old instructions that require admin access to the repo

1. Update `electron*` dependencies, if necessary.
2. Commit the changes.
3. Update the version using `npm version [major|minor|patch]` (it will create a new tag `vA.B.C`, note it down)
Expand Down

0 comments on commit dcd883b

Please sign in to comment.