Skip to content

Commit 926ee39

Browse files
author
hekuangsheng1
committed
docs: add MIT License and improve documentation
1 parent a5e2301 commit 926ee39

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

.github/workflows/java.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Java Build & Test
2+
3+
on:
4+
push:
5+
branches: [ main, master, develop ]
6+
pull_request:
7+
branches: [ main, master, develop ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
java-version: ['11', '17', '21']
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
19+
- name: Set up Java
20+
uses: actions/setup-java@v3
21+
with:
22+
java-version: ${{ matrix.java-version }}
23+
distribution: 'temurin'
24+
25+
- name: Cache Maven packages
26+
uses: actions/cache@v3
27+
with:
28+
path: ~/.m2
29+
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
30+
restore-keys: ${{ runner.os }}-m2
31+
32+
- name: Build with Maven
33+
run: mvn clean package -DskipTests
34+
continue-on-error: true
35+
36+
- name: Run Tests
37+
run: mvn test
38+
continue-on-error: true
39+
40+
code-quality:
41+
runs-on: ubuntu-latest
42+
43+
steps:
44+
- uses: actions/checkout@v3
45+
46+
- name: Set up Java
47+
uses: actions/setup-java@v3
48+
with:
49+
java-version: '17'
50+
distribution: 'temurin'
51+
52+
- name: Cache SonarCloud packages
53+
uses: actions/cache@v3
54+
with:
55+
path: ~/.sonar/cache
56+
key: ${{ runner.os }}-sonar
57+
restore-keys: ${{ runner.os }}-sonar
58+
59+
- name: Cache Maven packages
60+
uses: actions/cache@v3
61+
with:
62+
path: ~/.m2
63+
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
64+
restore-keys: ${{ runner.os }}-m2
65+
66+
- name: Build and analyze
67+
run: mvn clean verify
68+
continue-on-error: true

LICENSE

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

0 commit comments

Comments
 (0)