Skip to content

Commit 8360e60

Browse files
committed
create workflows for GitHub Actions
1 parent bd4d194 commit 8360e60

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Publish Docs Workflow
2+
run-name: ${{ github.actor }} is publishing document artifacts πŸš€
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
9+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
16+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
# Single deploy job since we're just deploying
23+
deploy:
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v4
33+
- name: Build html
34+
run: make html
35+
- name: Upload artifact
36+
uses: actions/upload-pages-artifact@v3
37+
with:
38+
# Upload build repository
39+
path: './_build/html'
40+
- name: Deploy to GitHub Pages
41+
id: deployment
42+
uses: actions/deploy-pages@v4
43+
44+
45+
46+
- run: echo "🍏 This job's status is ${{ job.status }}."
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Validate Docs Workflow
2+
run-name: ${{ github.actor }} is validating document source
3+
on: [pull_request, workflow_dispatch]
4+
jobs:
5+
Validate_Docs:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- run: echo "πŸŽ‰ The job was automatically triggered by a ${{ github.event_name }} event."
9+
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
10+
- run: echo "πŸ”Ž The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
11+
- name: Check out repo
12+
uses: actions/checkout@v4
13+
- name: Validate source
14+
run: make test
15+
- name: Build html
16+
run: make html
17+
- name: List built files
18+
run: |
19+
ls ${{ github.workspace }}/_build/html
20+
21+
- run: echo "🍏 This job's status is ${{ job.status }}."
22+

0 commit comments

Comments
Β (0)