Skip to content

Commit 514c4ea

Browse files
committed
Give names to every step in deploy workflow.
1 parent c92a996 commit 514c4ea

File tree

2 files changed

+31
-5
lines changed

2 files changed

+31
-5
lines changed

.github/workflows/deploy.yml

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
11
name: Documentation Deployment
2+
23
run-name: Deploying to GitHub Pages
4+
35
on:
46
push:
57
branches:
68
- main
9+
710
permissions:
811
contents: write
12+
913
jobs:
1014
deploy:
1115
runs-on: ubuntu-latest
1216
steps:
13-
- uses: actions/checkout@v2
14-
- uses: actions/setup-python@v2
15-
- run: pip install --upgrade pip
16-
- run: pip install mkdocs pymdown-extensions mkdocs-material
17-
- run: mkdocs gh-deploy --force
17+
- name: Checkout main branch
18+
uses: actions/checkout@v2
19+
20+
- name: Installing Python
21+
uses: actions/setup-python@v2
22+
with:
23+
# actions/setup-python recommends that python-version be fixed so that workflow runs are more
24+
# predictable.
25+
python-version: '3.12.7'
26+
27+
- name: Upgrade pip (Python package manager) version
28+
run: pip install --upgrade pip
29+
30+
- name: Install mkdocs
31+
run: pip install mkdocs
32+
33+
- name: Install pymdown-extensions
34+
run: pip install pymdown-extensions mkdocs-material
35+
36+
- name: Install mkdocs-material
37+
run: pip install mkdocs-material
38+
39+
# This step force-pushes the docs to the "gh-pages" branch of the parallelchain-docs repo.
40+
- name: Build and deploy mkdocs
41+
run: mkdocs gh-deploy --force

.github/workflows/pr-preview.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ on:
1010
- reopened
1111
- synchronize
1212
- closed
13+
1314
permissions:
1415
contents: write
1516
pull-requests: write
17+
1618
jobs:
1719
preview:
1820
name: 🚀 Preview

0 commit comments

Comments
 (0)