Skip to content

Commit

Permalink
Update README.md with modern release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
vtnate authored Jan 10, 2024
1 parent 17e8c7c commit 368ab9b
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,12 @@ Check out the repository and then execute:

## Releasing

* Update CHANGELOG.md
* Run `rake rubocop:auto_correct`
* Update version in `/lib/urbanopt/scenario/version.rb`
* On GitHub, go to the releases page and update the latest release tag (from develop). Name it “Version x.y.z”, set the previous tag to the appropriate value, and click the `Generate release notes` button
* Copy the text generated, which is sorted according to PR labels
* Discard the release or save as draft
* Update CHANGELOG.md appropriately, with dates and the content copied from GitHub
* Create PR to master, after tests and reviews complete, then merge
* In GitHub, make a new release or complete the previous one, basing off master/main
* Locally - from the master branch, run `rake release`
* On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the description box.

0 comments on commit 368ab9b

Please sign in to comment.