Skip to content

Commit da04e7f

Browse files
authored
Merge pull request #567 from qiniu/ci/docs
add action to generate javadoc
2 parents fd1d4e4 + 4783ea1 commit da04e7f

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

.github/workflows/generate-docs.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy static content to Pages
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
branches:
8+
- master
9+
10+
# Allows you to run this workflow manually from the Actions tab
11+
workflow_dispatch:
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# Allow one concurrent deployment
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: true
23+
24+
jobs:
25+
# Single deploy job since we're just deploying
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v3
34+
with:
35+
submodules: 'recursive'
36+
- name: Set up JDK
37+
uses: actions/setup-java@v1
38+
with:
39+
java-version: '11'
40+
- name: Generate Docs
41+
run: |
42+
rm -rf build/docs
43+
mkdir -p build/docs
44+
javadoc -sourcepath ./src/main/java -subpackages com -d ./build/docs -encoding UTF-8 -charset UTF-8 -windowtitle "七牛 Java SDK API 文档" -doctitle "Java SDK"
45+
- name: Setup Pages
46+
uses: actions/configure-pages@v2
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v1
49+
with:
50+
path: build/docs
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v1

0 commit comments

Comments
 (0)