Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ILIYANGERMANOV committed Aug 20, 2024
1 parent 9cd50be commit 080143e
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,23 @@ Also, currently, it only runs tests, but you can change this behaviour as you wi

The most part of the job is already automated for you. However, deployment to Maven Central requires some manual work from your side.

1. - [ ] Create an account at [Sonatype issue tracker](https://issues.sonatype.org/secure/Signup!default.jspa)
1. - [ ] [Create an issue](https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134) to create new project for you
1.
- [x] Create an account at [Sonatype issue tracker](https://issues.sonatype.org/secure/Signup!default.jspa)
1.
- [x] [Create an issue](https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134) to create new
project for you
1. - [ ] You will have to prove that you own your desired namespace
1. - [ ] Create a GPG key with `gpg --gen-key`, use the same email address you used to sign up to the Sonatype Jira
1. - [ ] Find your key id in the output of the previous command looking like `D89FAAEB4CECAFD199A2F5E612C6F735F7A9A519`
1. - [ ] Upload your key to a keyserver, for example
```bash
gpg --send-keys --keyserver keyserver.ubuntu.com "<your key id>"
```
1. - [ ] Now you should create secrets available to your GitHub Actions
1.
- [x] Create a GPG key with `gpg --gen-key`, use the same email address you used to sign up to the Sonatype Jira
1.
- [x] Find your key id in the output of the previous command looking like `D89FAAEB4CECAFD199A2F5E612C6F735F7A9A519`
1.
- [x] Upload your key to a keyserver, for example
```bash
gpg --send-keys --keyserver keyserver.ubuntu.com "<your key id>"
```
1.
- [x] Now you should create secrets available to your GitHub Actions
1. via `gh` command
```bash
gh secret set OSSRH_GPG_SECRET_KEY -a actions --body "$(gpg --export-secret-key --armor "<your key id>")"
Expand All @@ -52,7 +59,10 @@ The most part of the job is already automated for you. However, deployment to Ma
gh secret set OSSRH_USERNAME -a actions --body "<your sonatype account username>"
```
1. Or via the interface in `Settings``Secrets and Variables``Actions`, same variables as in 1.
1. - [ ] Edit deployment pom parameters in [`module.publication.gradle.kts`](convention-plugins/src/main/kotlin/module.publication.gradle.kts#L25-L44)
1. - [ ] Edit deploy targets in [`deploy.yml`](.github/workflows/deploy.yml#L23-L36)
1.
- [x] Edit deployment pom parameters in [
`module.publication.gradle.kts`](convention-plugins/src/main/kotlin/module.publication.gradle.kts#L25-L44)
1.
- [x] Edit deploy targets in [`deploy.yml`](.github/workflows/deploy.yml#L23-L36)
1. - [ ] Call deployment manually when ready [in Actions](../../actions/workflows/deploy.yml) → `Run Workflow`
1. - [ ] When you see in your account on https://oss.sonatype.org that everything is fine, you can release your staging repositories and add target `releaseSonatypeStagingRepository` to `deploy.yml` [after this line](.github/workflows/deploy.yml#L60). This way artifacts will be published to central automatically when tests pass.

0 comments on commit 080143e

Please sign in to comment.