Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mraffonso committed Mar 19, 2024
1 parent 0b3da64 commit 8c94f6d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Based on [SemanticVersion] from the standard library and is comparable with and
dependencies:
short_version:
github: mraffonso/short_version
version: ~> 0.1.0
```
2. Run `shards install`
Expand Down Expand Up @@ -176,11 +177,12 @@ Creating a release is three steps: tag a commit (the current one), push the tag

The current release workflow is:

* update the version specified in `shard.yml`
* commit with the message "Bump version to x.x.x"
* push to main
* run the release script with no arguments `./script/release`
* confirm release creation
* Update the version specified in `shard.yml`
* Update instances of the version in `README.md`
* Commit with the message "Bump version to x.x.x"
* Push to main
* Run the release script with no arguments `./script/release`
* Confirm release creation

And that's it, a release is created.

Expand Down

0 comments on commit 8c94f6d

Please sign in to comment.