Skip to content

Commit 2739a8b

Browse files
committed
Update release notes
1 parent db17da7 commit 2739a8b

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.dev.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
1+
# Prereqs
2+
3+
* You must have a local Ruby environment that can run the tests
4+
via `rake`.
5+
* You must have the [GitHub CLI tool (gh)](https://cli.github.com/)
6+
installed, in your path, and logged into an account that can
7+
make GitHub releases on the repo.
8+
* Your environment also must have `bash`, `git`, `perl`, and `sed`
9+
available.
10+
111
# How to release
212

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

0 commit comments

Comments
 (0)