@@ -3,18 +3,18 @@ name: Build and deploy an updated version of the website
33on :
44 push :
55 paths-ignore :
6- - ' historical/**'
7- - ' mediawiki-exporter/**'
8- - ' README.md'
9- - ' LICENSE'
6+ - " historical/**"
7+ - " mediawiki-exporter/**"
8+ - " README.md"
9+ - " LICENSE"
1010 pull_request :
1111 paths-ignore :
12- - ' historical/**'
13- - ' mediawiki-exporter/**'
14- - ' README.md'
15- - ' LICENSE'
12+ - " historical/**"
13+ - " mediawiki-exporter/**"
14+ - " README.md"
15+ - " LICENSE"
1616 schedule :
17- - cron : ' 42 16 1/7 * *'
17+ - cron : " 42 16 1/7 * *"
1818
1919# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
2020permissions :
@@ -36,83 +36,83 @@ jobs:
3636 name : Build Pan Docs
3737 runs-on : ubuntu-latest
3838 steps :
39- - name : Checkout pandocs
40- uses : actions/checkout@v4
41- with :
42- path : pandocs
43-
44- - name : Cache Rust build dir
45- uses : Swatinem/rust-cache@v2
46- with :
47- workspaces : pandocs/target /
48-
49- - name : Install mdbook
50- uses : peaceiris/actions-mdbook@v2
51- with :
52- mdbook-version : 0.4.40
53-
54- - name : Install static-sitemap-cli
55- run : npm install static-sitemap-cli
56-
57- - name : Install Python dependencies
58- run : |
59- python -m pip install --upgrade pip
60- pip install -r pandocs/requirements.txt
61-
62- - name : Build
63- working-directory : pandocs/
64- env :
65- MDBOOK_BUILD__CREATE_MISSING : " false" # Prevent creating missing files in SUMMARY.md
66- run : |
67- mdbook build
68-
69- - name : Generate sitemap
70- run : |
71- cd pandocs/docs/pandocs/
72- npx sscli --no-clean --base https://gbdev.io/pandocs
73-
74- - name : Upload artifact
75- uses : actions/upload-pages-artifact@v3
76- with :
77- path : pandocs/docs/pandocs/
39+ - name : Checkout pandocs
40+ uses : actions/checkout@v4
41+ with :
42+ path : pandocs
43+
44+ - name : Cache Rust build dir
45+ uses : Swatinem/rust-cache@v2
46+ with :
47+ workspaces : pandocs/
48+
49+ - name : Install mdbook
50+ uses : peaceiris/actions-mdbook@v2
51+ with :
52+ mdbook-version : 0.4.40
53+
54+ - name : Install static-sitemap-cli
55+ run : npm install static-sitemap-cli
56+
57+ - name : Install Python dependencies
58+ run : |
59+ python -m pip install --upgrade pip
60+ pip install -r pandocs/requirements.txt
61+
62+ - name : Build
63+ working-directory : pandocs/
64+ env :
65+ MDBOOK_BUILD__CREATE_MISSING : " false" # Prevent creating missing files in SUMMARY.md
66+ run : |
67+ mdbook build
68+
69+ - name : Generate sitemap
70+ run : |
71+ cd pandocs/docs/pandocs/
72+ npx sscli --no-clean --base https://gbdev.io/pandocs
73+
74+ - name : Upload artifact
75+ uses : actions/upload-pages-artifact@v3
76+ with :
77+ path : pandocs/docs/pandocs/
7878
7979 linkcheck :
8080 name : Check for dead links
8181 runs-on : ubuntu-latest
8282 steps :
83- - name : Checkout pandocs
84- uses : actions/checkout@v4
85- with :
86- path : pandocs
87-
88- - name : Cache Rust build dir
89- uses : Swatinem/rust-cache@v2
90- with :
91- workspaces : pandocs/target /
92-
93- - name : Install mdbook
94- uses : peaceiris/actions-mdbook@v2
95- with :
96- mdbook-version : 0.4.40
97-
98- # FIXME: Keep this up to date
99- - name : Install mdbook-linkcheck
100- run : | # `-L` because GitHub performs a redirection
101- curl -L -o mdbook-linkcheck.zip "https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v${MDBOOK_LINKCHECK_VER}/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip"
102- unzip mdbook-linkcheck.zip mdbook-linkcheck
103- chmod +x mdbook-linkcheck
104-
105- - name : Install Python dependencies
106- run : |
107- python -m pip install --upgrade pip
108- pip install -r pandocs/requirements.txt --break-system-packages
109-
110- - name : Check links
111- working-directory : pandocs/
112- env :
113- MDBOOK_OUTPUT__LINKCHECK__COMMAND : " ../mdbook-linkcheck"
114- run : |
115- mdbook build
83+ - name : Checkout pandocs
84+ uses : actions/checkout@v4
85+ with :
86+ path : pandocs
87+
88+ - name : Cache Rust build dir
89+ uses : Swatinem/rust-cache@v2
90+ with :
91+ workspaces : pandocs/
92+
93+ - name : Install mdbook
94+ uses : peaceiris/actions-mdbook@v2
95+ with :
96+ mdbook-version : 0.4.40
97+
98+ # FIXME: Keep this up to date
99+ - name : Install mdbook-linkcheck
100+ run : | # `-L` because GitHub performs a redirection
101+ curl -L -o mdbook-linkcheck.zip "https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v${MDBOOK_LINKCHECK_VER}/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip"
102+ unzip mdbook-linkcheck.zip mdbook-linkcheck
103+ chmod +x mdbook-linkcheck
104+
105+ - name : Install Python dependencies
106+ run : |
107+ python -m pip install --upgrade pip
108+ pip install -r pandocs/requirements.txt --break-system-packages
109+
110+ - name : Check links
111+ working-directory : pandocs/
112+ env :
113+ MDBOOK_OUTPUT__LINKCHECK__COMMAND : " ../mdbook-linkcheck"
114+ run : |
115+ mdbook build
116116
117117 deploy :
118118 name : Deploy to GitHub pages
0 commit comments