Skip to content

Commit 9042ba4

Browse files
committed
(to squash with the last commit) Address review comments
1 parent 158ee7b commit 9042ba4

File tree

2 files changed

+9
-28
lines changed

2 files changed

+9
-28
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,16 @@
1-
# This is a basic workflow to help you get started with Actions
2-
31
name: CI
42

5-
# Controls when the workflow will run
63
on:
7-
# Triggers the workflow on push or pull request events but only for the master branch
84
push:
95
branches: [ master ]
106
pull_request:
117
branches: [ master ]
128

13-
# Allows you to run this workflow manually from the Actions tab
14-
workflow_dispatch:
15-
16-
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
179
jobs:
18-
# This workflow contains a single job called "build"
1910
build:
20-
# The type of runner that the job will run on
2111
runs-on: ubuntu-latest
2212

23-
# Steps represent a sequence of tasks that will be executed as part of the job
2413
steps:
25-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
2614
- uses: actions/checkout@v2
2715

2816
- uses: actions/setup-java@v2
@@ -31,4 +19,4 @@ jobs:
3119
distribution: 'adopt'
3220

3321
- name: Run the Maven verify phase
34-
run: mvn --batch-mode --update-snapshots verify
22+
run: mvn --batch-mode verify

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,15 @@ Further reading:
1414
* [About API implemented in this library](http://doc.kaitai.io/stream_api.html)
1515
* [Java-specific notes](http://doc.kaitai.io/lang_java.html)
1616

17-
# Build
18-
To build library run the following command:
17+
## Build
18+
To build the library, run the following command:
1919

20-
```console
20+
```sh
2121
mvn install
2222
```
2323

24-
# Release
25-
To make a release ensure that you have:
26-
27-
- a [gpg](https://gnupg.org/) installed
28-
- a [configured](https://maven.apache.org/plugins/maven-gpg-plugin/usage.html) gpg signing key
29-
- pass `-DperformRelease=true` argument to the maven command invocation:
30-
31-
```console
32-
mvn -DperformRelease=true deploy
33-
```
34-
35-
See also http://doc.kaitai.io/developers.html#java.
24+
## Release
25+
<sub>
26+
If you are maintainer of this project please visit http://doc.kaitai.io/developers.html#java
27+
to get instructions how to make a release.
28+
</sub>

0 commit comments

Comments
 (0)