From 080143e985f0052fedd688dc72730c0960c28bae Mon Sep 17 00:00:00 2001 From: iliyangermanov Date: Tue, 20 Aug 2024 23:40:34 +0300 Subject: [PATCH] Update README --- README.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 133f4ac..e14a21b 100644 --- a/README.md +++ b/README.md @@ -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 "" - ``` -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 "" + ``` +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 "")" @@ -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 "" ``` 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.