Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve secrets documentation #839

Merged
merged 2 commits into from
Sep 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/central.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,9 @@ This configuration also determines the coordinates (`group:artifactId:version`)

## Secrets

For the publishing to work the credentials for Sonatype OSS as well as for the
GPG key that is used for signing need to provided. To keep them out of version
control it is recommended to either put this into the `gradle.properties` file
user home or to use environment variables for publishing from CI servers.
When publishing, you need to provide your Sonatype OSS credentials and signing GPG key.
To keep them out of version control, it is recommended to either put them in your user's
home `gradle.properties` file or to use environment variables (when publishing from CI servers).

=== "~/.gradle/gradle.properties"

Expand All @@ -242,6 +241,9 @@ user home or to use environment variables for publishing from CI servers.
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword=some_password
```

Note that the username/password here is *not* the same one you use to login; Sonatype publishing
requires a username/password that was generated via user tokens. The user token needs to be obtained on [Sonatype OSS](https://central.sonatype.org/publish/generate-token/) or the [Central Portal](https://central.sonatype.org/publish/generate-portal-token/) depending on where you publish.

### In memory GPG key

To obtain the in memory signing key run the following command.
Expand Down