Skip to content

Commit bffa731

Browse files
committed
Update notes on releasing
1 parent 708e288 commit bffa731

1 file changed

Lines changed: 26 additions & 74 deletions

File tree

README.dev.md

Lines changed: 26 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,38 @@
11
# Preparing your environment for a release
22

33
- Ensure you have access to publish to the repository on
4-
[Sonatype](https://oss.sonatype.org).
5-
- See the section about Sonatype access.
4+
[Central Portal](https://central.sonatype.org/).
5+
- See the section about Central Portal access.
66
- You need a GPG secret key. You need to publish it as well.
77
- See the section about setting up GPG.
88
- Ensure the SSH key you use on GitHub.com is available.
99
- e.g., `~/.ssh/id_rsa`.
1010
- Ensure an appropriate `~/.gitconfig` is set up.
1111
- The release process generates commits.
1212
- Ensure you have the necessary dependencies available:
13-
- e.g., `apt-get install maven openjdk-8-jdk git-core gpg`
13+
- e.g., `apt-get install maven default-jdk git-core`
1414
- Ensure [gh](https://github.com/cli/cli) is set up and in your
1515
`PATH`.
1616
- An easy way to do this is get a release tarball and run `./install`.
1717

18-
## Setting up Sonatype access
18+
## Setting up Central Portal access
1919

20-
To get this access, make an account on the [Sonatype JIRA issue
21-
tracker](https://issues.sonatype.org/) and make an issue asking for access
22-
[like so](https://issues.sonatype.org/browse/OSSRH-34414).
20+
To get this access, first create a Central Portal account. You will then need
21+
access to our namespace, but we have not added anyone since switching to
22+
Central Portal. Previously you would need to make an account on the [Sonatype
23+
JIRA issue tracker](https://issues.sonatype.org/) and make an issue asking for
24+
access [like so](https://issues.sonatype.org/browse/OSSRH-34414).
2325

2426
Ensure you inform MaxMind operations about your new access.
2527

26-
Put this information into `~/.m2/settings.xml` (Maven settings). Your
27-
`settings.xml` should look something like (replace USERNAME and SECRET):
28-
29-
<settings>
30-
<servers>
31-
<server>
32-
<id>ossrh</id>
33-
<username>USERNAME</username>
34-
<password>SECRET</password>
35-
</server>
36-
<server>
37-
<id>sonatype-nexus-snapshots</id>
38-
<username>USERNAME</username>
39-
<password>SECRET</password>
40-
</server>
41-
<server>
42-
<id>sonatype-nexus-staging</id>
43-
<username>USERNAME</username>
44-
<password>SECRET</password>
45-
</server>
46-
<server>
47-
<id>github-project-site</id>
48-
<username>git</username>
49-
</server>
50-
</servers>
51-
<profiles>
52-
<profile>
53-
<id>my_profile_id</id>
54-
<activation>
55-
<activeByDefault>true</activeByDefault>
56-
</activation>
57-
<properties>
58-
<gpg.keyname><!-- The GPG ID of your publishing key --></gpg.keyname>
59-
</properties>
60-
</profile>
61-
</profiles>
62-
</settings>
63-
64-
Some links about Sonatype:
65-
66-
* http://central.sonatype.org/pages/ossrh-guide.html
67-
* http://central.sonatype.org/pages/releasing-the-deployment.html
68-
* http://central.sonatype.org/pages/apache-maven.html
69-
70-
See the following documentation for details on specifying which gpg to use for
71-
publishing in your local settings.xml:
72-
73-
* https://central.sonatype.org/publish/requirements/gpg/
74-
* https://maven.apache.org/plugins/maven-gpg-plugin/usage.html
28+
Configure your `~/.m2/settings.xml` file for releasing to Central Portal. See
29+
[these instructions](https://central.sonatype.org/publish/publish-portal-maven/#credentials).
30+
31+
Some links about Central Portal:
32+
33+
* [Maven Central Repository homepage](https://central.sonatype.com/). You can
34+
sign-in from here.
35+
* [Publishing guide](https://central.sonatype.org/publish/publish-portal-maven/)
7536

7637
## Setting up GPG
7738

@@ -130,29 +91,20 @@ Add this to ~/.gnupg/gpg-agent.conf:
13091
version to the next development release, upload the release to GitHub
13192
and tag it, and upload to Sonatype.
13293
- This will prompt you several times. Generally you need to say `y` or `n`.
133-
- You'll be prompted for your ssh key password, GPG key password, and
134-
GitHub.com username and password several times depending on your
135-
workspace.
136-
- You may be prompted about "what is the next development version?". Hit
137-
enter to use the default which should be fine.
94+
- You may be prompted for your GitHub.com username and password several
95+
times depending on your workspace.
13896
- You may be prompted about "The following dependencies in Dependencies
13997
have newer versions". See the section about updating dependencies if so.
140-
- If you get HTTP 401 errors from Sonatype, you probably don't have a
141-
correct `settings.xml`. Refer to the Sonatype section.
142-
- If this happened, there are most likely pushed commits on GitHub.com.
143-
You can potentially rebase and drop the commits and force push and
144-
start over (you might want to talk about this before doing it). Note
145-
you'll need to delete the release tag too:
146-
`git push origin :refs/tags/vx.y.z && git tag -d vx.y.z`.
147-
- If you get to this point, then a release is on GitHub.com and in the
148-
staging repository on [Sonatype](https://oss.sonatype.org). The
149-
nexus-staging-maven-plugin plugin should automatically close the staging
150-
release as well as actually release it after.
98+
- If you get HTTP 401 errors from Central Portal, you probably don't have a
99+
correct `settings.xml`. Refer to the Central Portal section.
100+
- If you get to this point, then a release is on GitHub.com and Maven
101+
Central.
151102
- You're done!
152103
- If you want to check things over, look at the commits on GitHub.com,
153104
including to the `gh-pages` branch and release tags, and do an artifact
154-
search on [Sonatype](https://oss.sonatype.org) to see the version is as
155-
you expect.
105+
search on [Maven Central](https://central.sonatype.com/) to see the version
106+
is as you expect. It may take a few minutes for new releases to show up
107+
on Maven Central.
156108

157109
## Updating dependencies
158110

0 commit comments

Comments
 (0)