Skip to content

Commit

Permalink
Add GitHub Action to build project
Browse files Browse the repository at this point in the history
  • Loading branch information
Mingun committed Sep 12, 2023
1 parent 6a473d8 commit 0d47895
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 15 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -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
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<sub>
If you are maintainer of this project please visit http://doc.kaitai.io/developers.html#java
to get instructions how to make a release.
</sub>

0 comments on commit 0d47895

Please sign in to comment.