Skip to content

Commit

Permalink
Update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
oschwald committed Jan 12, 2024
1 parent db17da7 commit 73165ba
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.dev.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# Prereqs

* You must have a local Ruby environment that can run the tests
via `rake`.
* You must have the [GitHub CLI tool (gh)](https://cli.github.com/)
installed, in your path, and logged into an account that can
make GitHub releases on the repo.
* Your environment also must have `bash`, `git`, `perl`, and `sed`
available.

# How to release

See
[here](https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/main/README.dev.md).
* Review open issues and PRs to see if anything needs to be addresses
before release.
* Create a branch e.g. `horgh/release` and switch to it.
* `main` is protected.
* Set the release version and release date in `CHANGELOG.md`. Be sure
the version follows [Semantic Versionsing](https://semver.org/).
* Commit these changes.
* Run `dev-bin/release.sh`.
* Verify the release on the GitHub releases page.
* If everything goes well, the authorized releases will receive an email
to review the pending deployment. If you are an authorized releaser,
you will need to approve the release deployment run. If you are not,
you will have to wait for an authorized releaser to do so.
* Double check it looks okay at https://rubygems.org/gems/minfraud and
https://www.rubydoc.info/gems/minfraud.
* Make a PR and get it merged.

0 comments on commit 73165ba

Please sign in to comment.