Skip to content

Commit aaed21f

Browse files
authored
Add docs deployment workflow (#59)
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
1 parent e8b322b commit aaed21f

1 file changed

Lines changed: 79 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
# Uncomment to automatically push doc changes on merge to main
6+
# push:
7+
# branches: [main]
8+
# paths:
9+
# - 'docs/**'
10+
# - 'spring-data-valkey/src/main/resources/io/valkey/springframework/data/valkey/config/spring-valkey-1.0.xsd'
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- name: Setup Node.js
30+
uses: actions/setup-node@v4
31+
with:
32+
node-version: "20"
33+
cache: "npm"
34+
cache-dependency-path: docs/package-lock.json
35+
36+
- name: Setup JDK
37+
uses: actions/setup-java@v4
38+
with:
39+
java-version: "17"
40+
distribution: "temurin"
41+
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v4
44+
45+
- name: Install dependencies
46+
run: npm ci
47+
working-directory: ./docs
48+
49+
- name: Generate JavaDocs
50+
run: |
51+
./mvnw javadoc:javadoc -pl spring-data-valkey -DskipTests
52+
mkdir -p docs/dist/api/java
53+
cp -r spring-data-valkey/target/site/apidocs/* docs/dist/api/java/
54+
55+
- name: Copy Schema
56+
run: |
57+
mkdir -p docs/dist/schema/valkey
58+
cp spring-data-valkey/src/main/resources/io/valkey/springframework/data/valkey/config/spring-valkey-1.0.xsd docs/dist/schema/valkey/
59+
60+
- name: Build docs
61+
run: npm run build
62+
working-directory: ./docs
63+
64+
- name: Upload artifact
65+
uses: actions/upload-pages-artifact@v3
66+
with:
67+
path: ./docs/dist
68+
69+
deploy:
70+
environment:
71+
name: github-pages
72+
url: ${{ steps.deployment.outputs.page_url }}
73+
runs-on: ubuntu-latest
74+
needs: build
75+
76+
steps:
77+
- name: Deploy to GitHub Pages
78+
id: deployment
79+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)