From dc0a6a293d577cf9f66786537f4f6f2e78b2ab1f Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Tue, 19 Dec 2023 15:13:25 +0530 Subject: [PATCH] clean up --- .github/workflows/build-on-pr-create.yml | 2 +- .github/workflows/maven-publish.yml | 2 +- .github/workflows/publish-javadoc.yml | 2 +- Makefile | 5 ++++- README.md | 25 +++++++++++++++++++----- docs/publishing/readme.md | 19 ++++++++++++++++++ pom.xml | 2 +- 7 files changed, 47 insertions(+), 10 deletions(-) create mode 100644 docs/publishing/readme.md diff --git a/.github/workflows/build-on-pr-create.yml b/.github/workflows/build-on-pr-create.yml index 9c6a982..62dca67 100644 --- a/.github/workflows/build-on-pr-create.yml +++ b/.github/workflows/build-on-pr-create.yml @@ -19,7 +19,7 @@ jobs: steps: - uses: actions/checkout@v3 - - name: Set up JDK 8 + - name: Set up JDK 11 uses: actions/setup-java@v3 with: java-version: '11' diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml index 5ead5bd..e4441e4 100644 --- a/.github/workflows/maven-publish.yml +++ b/.github/workflows/maven-publish.yml @@ -22,7 +22,7 @@ jobs: steps: - uses: actions/checkout@v3 - - name: Set up JDK 8 + - name: Set up JDK 11 uses: actions/setup-java@v3 with: java-version: '11' diff --git a/.github/workflows/publish-javadoc.yml b/.github/workflows/publish-javadoc.yml index 59e9c77..d837e15 100644 --- a/.github/workflows/publish-javadoc.yml +++ b/.github/workflows/publish-javadoc.yml @@ -31,7 +31,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} steps: - uses: actions/checkout@v3 - - name: Set up JDK 8 + - name: Set up JDK 11 uses: actions/setup-java@v3 with: java-version: '11' diff --git a/Makefile b/Makefile index 699964a..d20481b 100644 --- a/Makefile +++ b/Makefile @@ -5,4 +5,7 @@ it: mvn clean verify -Pintegration-tests build: - mvn clean test install -Punit-tests \ No newline at end of file + mvn clean test install -Punit-tests + +release: + mvn clean release:prepare release:perform \ No newline at end of file diff --git a/README.md b/README.md index ddb3166..45e2ddf 100644 --- a/README.md +++ b/README.md @@ -78,17 +78,32 @@ your `pom.xml`: ``` -You should also include [SL4J](https://www.slf4j.org/) in your `pom.xml` file if you encounter any errors related to this. +You should also include an implementation of [SL4J](https://www.slf4j.org/) logger in your `pom.xml` file. For example, + +Use `slf4j-jdk14` implementation: ```xml - org.slf4j - slf4j-jdk14 - 2.0.9 - + org.slf4j + slf4j-jdk14 + 2.0.9 + ``` +or use `logback-classic` implementation: + +```xml + + + ch.qos.logback + logback-classic + 1.3.11 + +``` + +or use other suitable implementations. + #### Build: Build your project to resolve the dependencies: diff --git a/docs/publishing/readme.md b/docs/publishing/readme.md new file mode 100644 index 0000000..2e081cc --- /dev/null +++ b/docs/publishing/readme.md @@ -0,0 +1,19 @@ +GPG Signing setup + +## GPG Setup + +https://central.sonatype.org/publish/requirements/gpg/#listing-keys + +### Steps + +- Create key: `gpg --gen-key` and then list keys to verify: `gpg --list-keys` +- Distributing Your Public + Key: `gpg --keyserver keyserver.ubuntu.com --send-keys CA925CD6C9E8D064FF05B4728190C4130ABA0F98` +- Now other people can import your public key from the key server to their local + machines: `gpg --keyserver keyserver.ubuntu.com --recv-keys CA925CD6C9E8D064FF05B4728190C4130ABA0F98` + +## Maven publish + +https://central.sonatype.org/publish/publish-maven/ + +### Steps \ No newline at end of file diff --git a/pom.xml b/pom.xml index 725ae82..2d42a26 100644 --- a/pom.xml +++ b/pom.xml @@ -48,7 +48,7 @@ org.sonatype.plugins nexus-staging-maven-plugin - 1.6.8 + 1.6.13 true ossrh