From be128fe36054bcbd01a9e04ea41cf0193108020c Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 24 May 2021 00:27:14 +0000 Subject: [PATCH 1/5] Bump maven-javadoc-plugin from 3.2.0 to 3.7.0 Bumps [maven-javadoc-plugin](https://github.com/apache/maven-javadoc-plugin) from 3.2.0 to 3.7.0. - [Release notes](https://github.com/apache/maven-javadoc-plugin/releases) - [Commits](https://github.com/apache/maven-javadoc-plugin/compare/maven-javadoc-plugin-3.2.0...maven-javadoc-plugin-3.7.0) --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index c395d8c..d6d3be1 100644 --- a/pom.xml +++ b/pom.xml @@ -79,7 +79,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.2.0 + 3.7.0 attach-javadocs From ec108748cbc0dc163f459ea0fe9dcbe866e556a9 Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Mon, 10 May 2021 00:25:36 +0000 Subject: [PATCH 2/5] Bump maven-gpg-plugin from 1.5 to 3.2.5 Bumps [maven-gpg-plugin](https://github.com/apache/maven-gpg-plugin) from 1.5 to 3.2.5. - [Release notes](https://github.com/apache/maven-gpg-plugin/releases) - [Commits](https://github.com/apache/maven-gpg-plugin/compare/maven-gpg-plugin-1.5...maven-gpg-plugin-3.2.5) --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index d6d3be1..0a4caa4 100644 --- a/pom.xml +++ b/pom.xml @@ -119,7 +119,7 @@ org.apache.maven.plugins maven-gpg-plugin - 1.5 + 3.2.5 sign-artifacts From cf0c4788a1ea42e714e0f2cec20eed70c5ceabe2 Mon Sep 17 00:00:00 2001 From: Mingun Date: Sun, 8 Aug 2021 14:58:57 +0500 Subject: [PATCH 3/5] Bump maven-source-plugin from 2.2.1 to 3.3.1 Bumps [maven-source-plugin](https://github.com/apache/maven-source-plugin) from 2.2.1 to 3.3.1. - [Release notes](https://github.com/apache/maven-source-plugin/releases) - [Commits](https://github.com/apache/maven-source-plugin/compare/maven-source-plugin-2.2.1...maven-source-plugin-3.3.1) --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 0a4caa4..82afe80 100644 --- a/pom.xml +++ b/pom.xml @@ -66,7 +66,7 @@ org.apache.maven.plugins maven-source-plugin - 2.2.1 + 3.3.1 attach-sources From afdb47013e6276b5fbb18f83ab6efc29cdacdffc Mon Sep 17 00:00:00 2001 From: Mingun Date: Sun, 8 Aug 2021 15:23:46 +0500 Subject: [PATCH 4/5] Add ability to test build without signing and add build instructions to the README.md See https://stackoverflow.com/a/14869692/7518605 Use mvn -DperformRelease=true ... if you need to sign your build --- README.md | 20 ++++++++++++++++++++ pom.xml | 41 +++++++++++++++++++++++++++-------------- 2 files changed, 47 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8386d5a..b3dfd99 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,23 @@ Further reading: * [About Kaitai Struct](http://kaitai.io/) * [About API implemented in this library](http://doc.kaitai.io/stream_api.html) * [Java-specific notes](http://doc.kaitai.io/lang_java.html) + +# Build +To build library run the following command: + +```console +mvn install +``` + +# Release +To make a release ensure that you have: + +- a [gpg](https://gnupg.org/) installed +- a [configured](https://maven.apache.org/plugins/maven-gpg-plugin/usage.html) gpg signing key +- pass `-DperformRelease=true` argument to the maven command invocation: + + ```console + mvn -DperformRelease=true deploy + ``` + +See also http://doc.kaitai.io/developers.html#java. diff --git a/pom.xml b/pom.xml index 82afe80..cb465e5 100644 --- a/pom.xml +++ b/pom.xml @@ -54,6 +54,33 @@ 7 + + release-sign-artifacts + + + performRelease + true + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 3.2.5 + + + sign-artifacts + verify + + sign + + + + + + + @@ -116,20 +143,6 @@ - - org.apache.maven.plugins - maven-gpg-plugin - 3.2.5 - - - sign-artifacts - verify - - sign - - - - From 581024fa44fc174b08f0fdffc4e3f8424c253a1a Mon Sep 17 00:00:00 2001 From: Mingun Date: Sun, 8 Aug 2021 15:30:19 +0500 Subject: [PATCH 5/5] Add GitHub Action to build project --- .github/workflows/build.yml | 22 ++++++++++++++++++++++ README.md | 23 ++++++++--------------- 2 files changed, 30 insertions(+), 15 deletions(-) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..d64b48a --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,22 @@ +name: CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-java@v2 + with: + java-version: '17' + distribution: 'adopt' + + - name: Run the Maven verify phase + run: mvn --batch-mode verify diff --git a/README.md b/README.md index b3dfd99..3adccca 100644 --- a/README.md +++ b/README.md @@ -14,22 +14,15 @@ Further reading: * [About API implemented in this library](http://doc.kaitai.io/stream_api.html) * [Java-specific notes](http://doc.kaitai.io/lang_java.html) -# Build -To build library run the following command: +## Build +To build the library, run the following command: -```console +```sh mvn install ``` -# Release -To make a release ensure that you have: - -- a [gpg](https://gnupg.org/) installed -- a [configured](https://maven.apache.org/plugins/maven-gpg-plugin/usage.html) gpg signing key -- pass `-DperformRelease=true` argument to the maven command invocation: - - ```console - mvn -DperformRelease=true deploy - ``` - -See also http://doc.kaitai.io/developers.html#java. +## Release + +If you are maintainer of this project please visit http://doc.kaitai.io/developers.html#java +to get instructions how to make a release. + \ No newline at end of file