Skip to content

Commit 8b5c36e

Browse files
author
xlui
committed
Update README and add JDK 13
1 parent a972d14 commit 8b5c36e

File tree

14 files changed

+286
-31
lines changed

14 files changed

+286
-31
lines changed

‎Dockerfile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
FROM maven:3.6.0-jdk-11-slim
1+
FROM maven:3.6-jdk-11-slim
22

33
LABEL "name"="Maven CLI Action with JDK 11"
44
LABEL "maintainer"="xlui <i@xlui.me>"
5-
LABEL "version"="1.0.0"
5+
LABEL "version"="1.1.0"
66

77
LABEL "com.github.actions.name"="GitHub Action for Maven & JDK 11"
88
LABEL "com.github.actions.description"="Provide maven cli for JDK 11 projects."
@@ -12,4 +12,4 @@ COPY LICENSE README.md /
1212

1313
COPY entrypoint.sh /entrypoint.sh
1414

15-
ENTRYPOINT ["/entrypoint.sh"]
15+
ENTRYPOINT ["/entrypoint.sh"]

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 xlui
3+
Copyright (c) 2019-2020 xlui
44

55
Copyright (c) 2018 Luca Feger
66

‎README.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,60 @@ The GitHub Action for [Maven](https://maven.apache.org/) wraps the Maven CLI to
66

77
## Usage
88

9+
```yml
10+
# This is a basic workflow to help you get started with Actions
911

12+
name: CI
13+
14+
# Controls when the action will run. Triggers the workflow on push or pull request
15+
# events but only for the master branch
16+
on:
17+
push:
18+
branches: [ master ]
19+
pull_request:
20+
branches: [ master ]
21+
22+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
23+
jobs:
24+
# This workflow contains a single job called "build"
25+
build:
26+
# The type of runner that the job will run on
27+
runs-on: ubuntu-latest
28+
29+
# Steps represent a sequence of tasks that will be executed as part of the job
30+
steps:
31+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
32+
- uses: actions/checkout@v2
33+
34+
# Runs a single command using the runners shell
35+
- name: Run a one-line script
36+
run: echo Hello, world!
37+
38+
# Runs a set of commands using the runners shell
39+
- name: Run maven script
40+
uses: xlui/action-maven-cli/jdk11@master
41+
id: test
42+
with:
43+
lifecycle: 'clean package test'
44+
```
45+
46+
Under the last `jobs.build.steps.name` you can set the value of `uses` to this action.
47+
48+
```yml
49+
uses: xlui/action-maven-cli/jdk11@master
50+
```
51+
52+
or
53+
54+
```yml
55+
uses: xlui/action-maven-cli/jdk8@master
56+
```
57+
58+
As JDK 11 is the latest LTS JDK, there is a convenient way to use it:
59+
60+
```yml
61+
uses: xlui/action-maven-cli@master
62+
```
1063

1164
## License
1265

‎action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: 'Maven CLI for the GitHub Actions'
2-
description: 'Use Maven CLI with JDK 8, 10, 11, 12, 13'
2+
description: 'Use Maven CLI with JDK 8, 11, 13'
33
inputs:
44
lifecycle:
55
description: 'Maven lifecycles'

‎jdk11/Dockerfile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
FROM maven:3.6.0-jdk-11-slim
1+
FROM maven:3.6-jdk-11-slim
22

33
LABEL "name"="Maven CLI Action with JDK 11"
44
LABEL "maintainer"="xlui <i@xlui.me>"
5-
LABEL "version"="1.0.0"
5+
LABEL "version"="1.1.0"
66

77
LABEL "com.github.actions.name"="GitHub Action for Maven & JDK 11"
88
LABEL "com.github.actions.description"="Provide maven cli for JDK 11 projects."
@@ -12,4 +12,4 @@ COPY LICENSE README.md /
1212

1313
COPY entrypoint.sh /entrypoint.sh
1414

15-
ENTRYPOINT ["/entrypoint.sh"]
15+
ENTRYPOINT ["/entrypoint.sh"]

‎jdk11/LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 xlui
3+
Copyright (c) 2019-2020 xlui
44

55
Copyright (c) 2018 Luca Feger
66

‎jdk11/README.md‎

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,64 @@
1-
# GitHub Action for the Maven CLI with JDK 11
1+
# GitHub Action for the Maven CLI
22

3-
The GitHub Action for [Maven](https://maven.apache.org/) wraps the Maven CLI with JDK 11 to enable Maven commands to be run. This can be used to run every Maven Command.
3+
The [origin project](https://github.com/LucaFeger/action-maven-cli) creates a Maven action with only JDK 8. But I'm writing java with JDK 11 and in the short future I'll keep using JDK 11. So I have forked the origin repository and add support for JDK 11.
4+
5+
The GitHub Action for [Maven](https://maven.apache.org/) wraps the Maven CLI to enable Maven commands to be run. This can be used to run every Maven Command.
46

57
## Usage
68

7-
The normalised usage or this GitHub Action is the following code:
9+
```yml
10+
# This is a basic workflow to help you get started with Actions
11+
12+
name: CI
13+
14+
# Controls when the action will run. Triggers the workflow on push or pull request
15+
# events but only for the master branch
16+
on:
17+
push:
18+
branches: [ master ]
19+
pull_request:
20+
branches: [ master ]
21+
22+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
23+
jobs:
24+
# This workflow contains a single job called "build"
25+
build:
26+
# The type of runner that the job will run on
27+
runs-on: ubuntu-latest
28+
29+
# Steps represent a sequence of tasks that will be executed as part of the job
30+
steps:
31+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
32+
- uses: actions/checkout@v2
833

34+
# Runs a single command using the runners shell
35+
- name: Run a one-line script
36+
run: echo Hello, world!
37+
38+
# Runs a set of commands using the runners shell
39+
- name: Run maven script
40+
uses: xlui/action-maven-cli/jdk11@master
41+
id: test
42+
with:
43+
lifecycle: 'clean package test'
944
```
10-
action "package" {
11-
uses = "xlui/action-maven-cli/jdk11@master"
12-
args = "clean package"
13-
}
45+
46+
Under the last `jobs.build.steps.name` you can set the value of `uses` to this action.
47+
48+
```yml
49+
uses: xlui/action-maven-cli/jdk11@master
1450
```
1551

16-
But in order to keep forward-compatibility, you can also use this GitHub Action in the following way:
52+
or
1753

54+
```yml
55+
uses: xlui/action-maven-cli/jdk8@master
1856
```
19-
action "package" {
20-
uses = "xlui/action-maven-cli@master"
21-
args = "clean package"
22-
}
57+
58+
As JDK 11 is the latest LTS JDK, there is a convenient way to use it:
59+
60+
```yml
61+
uses: xlui/action-maven-cli@master
2362
```
2463

2564
## License

‎jdk13/Dockerfile‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
FROM maven:3.6-jdk-13
2+
3+
LABEL "name"="Maven CLI Action with JDK 13"
4+
LABEL "maintainer"="xlui <i@xlui.me>"
5+
LABEL "version"="1.1.0"
6+
7+
LABEL "com.github.actions.name"="GitHub Action for Maven & JDK 13"
8+
LABEL "com.github.actions.description"="Provide maven cli for JDK 13 projects."
9+
LABEL "com.github.actions.icon"="package"
10+
LABEL "com.github.actions.color"="green"
11+
COPY LICENSE README.md /
12+
13+
COPY entrypoint.sh /entrypoint.sh
14+
15+
ENTRYPOINT ["/entrypoint.sh"]

‎jdk13/LICENSE‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
MIT License
2+
3+
Copyright (c) 2019-2020 xlui
4+
5+
Copyright (c) 2018 Luca Feger
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

‎jdk13/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# GitHub Action for the Maven CLI
2+
3+
The [origin project](https://github.com/LucaFeger/action-maven-cli) creates a Maven action with only JDK 8. But I'm writing java with JDK 11 and in the short future I'll keep using JDK 11. So I have forked the origin repository and add support for JDK 11.
4+
5+
The GitHub Action for [Maven](https://maven.apache.org/) wraps the Maven CLI to enable Maven commands to be run. This can be used to run every Maven Command.
6+
7+
## Usage
8+
9+
```yml
10+
# This is a basic workflow to help you get started with Actions
11+
12+
name: CI
13+
14+
# Controls when the action will run. Triggers the workflow on push or pull request
15+
# events but only for the master branch
16+
on:
17+
push:
18+
branches: [ master ]
19+
pull_request:
20+
branches: [ master ]
21+
22+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
23+
jobs:
24+
# This workflow contains a single job called "build"
25+
build:
26+
# The type of runner that the job will run on
27+
runs-on: ubuntu-latest
28+
29+
# Steps represent a sequence of tasks that will be executed as part of the job
30+
steps:
31+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
32+
- uses: actions/checkout@v2
33+
34+
# Runs a single command using the runners shell
35+
- name: Run a one-line script
36+
run: echo Hello, world!
37+
38+
# Runs a set of commands using the runners shell
39+
- name: Run maven script
40+
uses: xlui/action-maven-cli/jdk11@master
41+
id: test
42+
with:
43+
lifecycle: 'clean package test'
44+
```
45+
46+
Under the last `jobs.build.steps.name` you can set the value of `uses` to this action.
47+
48+
```yml
49+
uses: xlui/action-maven-cli/jdk11@master
50+
```
51+
52+
or
53+
54+
```yml
55+
uses: xlui/action-maven-cli/jdk8@master
56+
```
57+
58+
As JDK 11 is the latest LTS JDK, there is a convenient way to use it:
59+
60+
```yml
61+
uses: xlui/action-maven-cli@master
62+
```
63+
64+
## License
65+
66+
The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE.md).

0 commit comments

Comments
 (0)