-
Notifications
You must be signed in to change notification settings - Fork 2
97 lines (82 loc) · 2.26 KB
/
documentation.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
name: documentation
on:
push:
branches:
- main
- develop
jobs:
documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout the repo
uses: actions/checkout@v4
- name: Set up JDK 1.8
uses: actions/setup-java@v3
with:
java-version: '8'
distribution: 'corretto'
- name: Validate Gradle wrapper
uses: gradle/wrapper-validation-action@v1
- name: Setup Gradle
uses: gradle/gradle-build-action@v2
- name: Generate javadoc
run: |
./gradlew javadoc
touch docs/javadoc/.nojekyll
- name: Publish docs
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/javadoc
clean-exclude: |
_badges
_coverage
- name: Extract project version
run: |
echo "VERSION=$(grep -oP 'version = "\K([0-9\.]+)(?=")' build.gradle)" >> $GITHUB_ENV
- name: Generate version badge
uses: knightdave/[email protected]
with:
file: docs/_badges/version.svg
label: version
value: v${{ env.VERSION }}
color: teal
template: docs/_badges/template.svg
overwrite: true
- name: Generate license badge
uses: knightdave/[email protected]
with:
file: docs/_badges/license.svg
label: license
value: BSD-3-Clause
color: yellowgreen
template: docs/_badges/template.svg
overwrite: true
- name: Generate passing badge
if: success()
uses: knightdave/[email protected]
with:
file: docs/_badges/documentation.svg
label: docs
value: passing
color: green
template: docs/_badges/template.svg
overwrite: true
- name: Generate failing badge
if: failure()
uses: knightdave/[email protected]
with:
file: docs/_badges/documentation.svg
label: docs
value: failing
color: red
template: docs/_badges/template.svg
overwrite: true
- name: Publish badge
if: success() || failure()
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/_badges
target-folder: _badges
clean: false