Skip to content

Commit

Permalink
Add documentation about publishing a new release version
Browse files Browse the repository at this point in the history
  • Loading branch information
guzel-samigullina committed Dec 5, 2023
1 parent fad9cf8 commit 73a6734
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
53 changes: 52 additions & 1 deletion DEPLOYMENT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,56 @@
Follow https://central.sonatype.org/pages/apache-maven.html
# Deploying of new release version

To release a new version, you need manually publish it to maven repository (Maven Central). This requires the following steps:

1. Set up and configure GPG key for generating a signature. See this [guide](https://central.sonatype.org/pages/working-with-pgp-signatures.html)
for more information.
2. Install GnuPG or jump to the next point.
3. Using `gpg --list-signatures` check if you have a key. If not, generate one using `gpg --gen-key`.
4. During creation process, you will need to create a passphrase. This passphrase and your private key are all that
is needed to sign artifacts with your signature.
2. Don't forget to add your public key to the [key server](https://central.sonatype.org/publish/requirements/gpg/#gpg-signed-components)
so that others can verify your signature.
3. Set environment variable `GPG_TTY`:
```
export GPG_TTY=$(tty)
```
2. Configure account details to deploy to OSSRH
3. Find the configuration file for Maven - `settings.xml` file. It is located either in `~/.m2/settings.xml`
(single user configuration) or in `/opt/homebrew/Cellar/maven/[version]/libexec/conf` (configuration for all Maven users on a machine).
4. Add the pb Jira Sonatype account credentials to the `settings.xml`:
```xml
<settings>
<servers>
<server>
<id>ossrh</id>
<username>Engineering</username>
<password>[password from 1Password - look for "Stargate Sonatype" item]</password>
</server>
</servers>
</settings>
```
5. Add GPG passphrase to the `settings.xml`:
```xml
<settings>
<profiles>
<profile>
<id>ossrh</id>
<properties>
<gpg.passphrase>[passphrase]</gpg.passphrase>
</properties>
</profile>
</profiles>
</settings>
```
3. And finally publish the new version:
```
mvn clean deploy
```

4. Check that new version is available in [Maven central](https://central.sonatype.com/artifact/io.github.productboardlabs/jackson-kafka-avro-serializer/overview)
(publishing may take a few minutes).


Follow this [guide](https://central.sonatype.org/pages/apache-maven.htmlguide) for more information.


3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ implementation("io.github.productboardlabs:jackson-kafka-avro-serializer:0.7.1")
- Support for use latest version flag
- Do not use deprecated methods from Kafka Avro serializer

# Deploying of new release version

To deploy a new release version to Maven Central, follow the [following guide](DEPLOYMENT.md).

# Release notes

Expand Down

0 comments on commit 73a6734

Please sign in to comment.