Skip to content

Commit 88d6fa7

Browse files
authored
Add documentation workflow
1 parent b0dfe70 commit 88d6fa7

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
3+
name: Documentation
4+
5+
on: # yamllint disable-line rule:truthy
6+
push:
7+
branches: [master, simplesamlphp-*]
8+
paths:
9+
- '**.md'
10+
pull_request:
11+
branches: [master, simplesamlphp-*]
12+
paths:
13+
- '**.md'
14+
workflow_dispatch:
15+
16+
jobs:
17+
quality:
18+
name: Quality checks
19+
runs-on: [ubuntu-latest]
20+
21+
steps:
22+
- uses: actions/checkout@v5
23+
24+
- name: Lint markdown files
25+
uses: nosborn/github-action-markdown-cli@v3
26+
with:
27+
files: .
28+
ignore_path: .markdownlintignore
29+
30+
- name: Perform spell check
31+
uses: codespell-project/actions-codespell@v2
32+
with:
33+
path: '**/*.md'
34+
check_filenames: true
35+
ignore_words_list: tekst
36+
37+
build:
38+
name: Build documentation
39+
needs: quality
40+
runs-on: [ubuntu-latest]
41+
42+
steps:
43+
- name: Run docs build
44+
if: github.event_name != 'pull_request'
45+
uses: actions/github-script@v8
46+
with:
47+
# Token has to be generated on a user account that controls the docs-repository.
48+
# The _only_ scope to select is "Access public repositories", nothing more.
49+
github-token: ${{ secrets.PAT_TOKEN }}
50+
script: |
51+
await github.rest.actions.createWorkflowDispatch({
52+
owner: 'simplesamlphp',
53+
repo: 'docs',
54+
workflow_id: 'mk_docs.yml',
55+
ref: 'main'
56+
})

0 commit comments

Comments
 (0)