Skip to content

Commit 455fbd2

Browse files
committed
GitHub pages workflow
1 parent 6600a2d commit 455fbd2

File tree

2 files changed

+95
-0
lines changed

2 files changed

+95
-0
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: scaladoc
2+
3+
on:
4+
push:
5+
branches:
6+
- 'scaladoc-fixes'
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
18+
jobs:
19+
deploy:
20+
environment:
21+
name: github-pages
22+
url: ${{ steps.deployment.outputs.page_url }}
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Git Checkout
26+
uses: actions/checkout@v3
27+
28+
- name: Set up JDK 17
29+
uses: actions/setup-java@v3
30+
with:
31+
distribution: 'temurin'
32+
java-version: 17
33+
cache: 'sbt'
34+
35+
- name: Locally publish self
36+
run: ./project/scripts/sbt scaladoc/publishLocal
37+
38+
- name: Generate self documentation
39+
run: ./project/scripts/sbt scaladoc/generateSelfDocumentation
40+
41+
- name: Generate testcases documentation
42+
run: ./project/scripts/sbt scaladoc/generateTestcasesDocumentation
43+
44+
- name: Generate reference documentation
45+
run: ./project/scripts/sbt scaladoc/generateReferenceDocumentation
46+
47+
- name: Generate Scala 3 documentation
48+
run: ./project/scripts/sbt scaladoc/generateScalaDocumentation
49+
50+
- name: Generate documentation for example project using dotty-sbt
51+
run: ./project/scripts/sbt "sbt-test/scripted sbt-dotty/scaladoc"
52+
53+
- name: Generate index file
54+
run: scaladoc/scripts/mk-index.sh scaladoc/output > scaladoc/output/index.html
55+
56+
- name: Setup Pages
57+
uses: actions/configure-pages@v2
58+
59+
- name: Upload artifact
60+
uses: actions/upload-pages-artifact@v1
61+
with:
62+
# Upload scaladoc content
63+
path: 'scaladoc/output'
64+
65+
- name: Deploy to GitHub Pages
66+
id: deployment
67+
uses: actions/deploy-pages@v1

.github/workflows/scaladoc-test.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: scaladoc
2+
3+
on: push
4+
5+
permissions:
6+
contents: read
7+
8+
jobs:
9+
test:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Git Checkout
13+
uses: actions/checkout@v3
14+
15+
- name: Set up JDK 17
16+
uses: actions/setup-java@v3
17+
with:
18+
distribution: 'temurin'
19+
java-version: 17
20+
cache: 'sbt'
21+
22+
- name: Compile and test scala3doc-js
23+
run: ./project/scripts/sbt scaladoc-js-main/test
24+
25+
- name: Compile and test
26+
run: |
27+
./project/scripts/sbt scaladoc/test
28+
./project/scripts/cmdScaladocTests

0 commit comments

Comments
 (0)