Skip to content

Commit 4b1d2fc

Browse files
committed
Expand and update release instructions
1 parent fc1eea1 commit 4b1d2fc

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.dev.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@
33
* Update changelog: Set version and release date
44
* Set version in `maxmind-db.gemspec`
55
* Add them: `git add -p`
6+
* Create a branch e.g. `horgh/release` and switch to it.
7+
* `main` is protected.
68
* Commit: `git commit -m v1.0.0`
79
* Tag: `git tag -a v1.0.0 -m v1.0.0`
810
* Clean up to be sure nothing stray gets into gem: `git clean -dxff`
911
* Create `.gem` file: `gem build maxmind-db.gemspec`
1012
* Complete prerequisites (see below)
11-
* You only need to do this if `~/.gem/credentials` is missing
12-
`:rubygems_api_key`.
13+
* You only need to do this once. You can tell if this is necessary if you
14+
are lacking `:rubygems_api_key` in `~/.local/share/gem/credentials`
15+
(previously `~/.gem/credentials`)
1316
* Upload to rubygems.org: `gem push maxmind-db-1.0.0.gem`
1417
* Push: `git push`
1518
* Push tag: `git push --tags`
19+
* Make a PR and get it merged.
1620
* Double check it looks okay at https://rubygems.org/gems/maxmind-db and
1721
https://www.rubydoc.info/gems/maxmind-db
1822

@@ -22,7 +26,7 @@
2226
## Step 1
2327
Sign up for an account at rubygems.org if you don't have one.
2428

25-
Enable multi factor authentication.
29+
Enable multi factor authentication (for both UI and API).
2630

2731

2832
## Step 2
@@ -33,5 +37,9 @@ They do this by using the `gem owner` command
3337

3438

3539
## Step 3
36-
Go to your rubygems.org profile and find the curl command to run to
37-
download your API key.
40+
Run `gem signin`. This will prompt you for your username and password, and
41+
then create an API key for you. Select the scopes `index_rubygems` and
42+
`push_rubygem` (I'm not sure the former is required, but anyway).
43+
44+
Note you may need an up to date version of rubygems to do this as I believe
45+
support for API keys like this is a newer addition.

0 commit comments

Comments
 (0)