Skip to content

Commit

Permalink
Add GPG instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
p-goulart committed Dec 5, 2023
1 parent 92973a8 commit 5d17f15
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,27 @@ If you are an LT team member, you should have access to these credentials in a s
is `SonaType`). If you are an opensource developer (i.e. not an LT employee or freelance collaborator) and would still
like to release your own version of the dictionary, please contact the [maintainers](#maintainer).

#### GPG setup

The [pom.xml](./results/java-lt/pom.xml) file in thsi repo is set up to take GPG credentials from your environment:

```xml
<!-- ... -->
<properties>
<!-- ... -->
<gpg.keyname>${env.GPG_KEYNAME}</gpg.keyname>
<gpg.passphrase>${env.GPG_PASSPHRASE}</gpg.passphrase>
</properties>
<!-- ... -->
```

But, of course, do **not** store your GPG credentials in plaintext. If you have the 1password CLI set up, make sure you
handle your secrets with 1password and call the release command with `op run --`, like:

```bash
op run -- mvn clean deploy -P release
```

### Versioning

These dictionaries use [semantic versioning](https://semver.org), as they are essentially libraries that can be
Expand Down

0 comments on commit 5d17f15

Please sign in to comment.