Skip to content

Commit

Permalink
Release v0.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
imustafin committed Jan 23, 2023
1 parent 79405ed commit cb13efb
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
17 changes: 12 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Moved render mode selection from buttons to a menu

### Fixed

## [0.0.1]
## [v0.0.2]
Small release to check the release process

### Added

- Moved render mode selection from buttons to a menu
- About message

## [v0.0.1]
The first proper release! :rage1:

### Added
Expand All @@ -23,5 +29,6 @@ with downloads available from the [releases](https://github.com/imustafin/pbdoom
page
- Control buttons placement is computed based on screen dimensions [#1](https://github.com/imustafin/pbdoom/issues/1)

[unreleased]: https://github.com/imustafin/pbdoom/compare/v0.0.1...HEAD
[0.0.1]: https://github.com/imustafin/pbdoom/releases/tag/v0.0.1
[unreleased]: https://github.com/imustafin/pbdoom/compare/v0.0.2...HEAD
[v0.0.2]: https://github.com/imustafin/pbdoom/compare/tag/v0.0.1...v0.0.2
[v0.0.1]: https://github.com/imustafin/pbdoom/releases/tag/v0.0.1
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,17 @@ Don't forget to update ip addresses and ports in all scripts.
Check the ereader's ip in wifi settings for the connected network.

### Releasing
1. Choose the release version (e.g. `0.0.1`)
1. Choose the release version (e.g. `v0.0.1`)
2. Update the changelog
1. Change `[Unreleased]` title to the version (`[0.0.1]`)
1. Change `[Unreleased]` title to the version (`[v0.0.1]`)
2. Make a new `[Unreleased]` title with `### Added` and `### Fixed`
3. At the end of file, add link for the release (`[0.0.1] .../compare/v0.0.0...v0.0.1`)
3. At the end of file, add link for the release (`[v0.0.1] .../compare/v0.0.0...v0.0.1`)
4. Update the `[unreleased]` link (`[unreleased]: .../compare/v0.0.1...HEAD`)
3. Add and push tag (`v0.0.1`)
3. Push changelog updates to `main`
4. Grab the artifact
5. Make a GitHub release
1. Set the version, add `v` prefix (`v0.0.1`)
1. Set the version
2. Paste changelog of the release
* Don't add the release title (already shown by GitHub)
* Make headings (Added, Fixed) start from `h1` (`#`)

0 comments on commit cb13efb

Please sign in to comment.