Skip to content

Commit 1e9b93f

Browse files
authored
Initialize test
0 parents  commit 1e9b93f

87 files changed

Lines changed: 4538 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Main Documentation Checks
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
# Manual trigger
8+
workflow_dispatch:
9+
10+
concurrency:
11+
group: ${{ github.workflow }}-${{ github.ref }}
12+
cancel-in-progress: true
13+
14+
jobs:
15+
documentation-checks:
16+
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@test
17+
with:
18+
working-directory: "sp-docs"
19+
fetch-depth: 0
20+
# runs-on: '["self-hosted", "Linux", "amd64", "noble"]'
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Keep action in sync
2+
3+
on:
4+
pull_request_target:
5+
paths:
6+
- .github/workflows/automatic-doc-checks.yml
7+
- sp-files/.github/workflows/automatic-doc-checks.yml
8+
9+
jobs:
10+
comment:
11+
runs-on: [self-hosted, Linux, amd64, noble]
12+
steps:
13+
- uses: actions/github-script@v7
14+
with:
15+
script: |
16+
github.rest.issues.createComment({
17+
issue_number: context.issue.number,
18+
owner: context.repo.owner,
19+
repo: context.repo.repo,
20+
body: 'Make sure to keep `.github/workflows/automatic-doc-checks.yml` and `sp-files/.github/workflows/automatic-doc-checks.yml` in sync!'
21+
})
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# This workflow runs the init.sh script to test setting up
2+
# the starter pack.
3+
# You shouldn't run this workflow on any repos that use the
4+
# starter pack.
5+
6+
name: Test starter pack
7+
8+
on:
9+
- pull_request
10+
- push
11+
12+
jobs:
13+
test-root:
14+
name: Test in root folder
15+
runs-on: [self-hosted, Linux, amd64, noble]
16+
steps:
17+
- name: Check out repo
18+
uses: actions/checkout@v4
19+
- name: Run init and build
20+
env:
21+
default_filetype_choice: md # don't prompt for user choice
22+
run: sp-tests/run-init-and-build.sh
23+
- name: Add some files, build, and test
24+
run: sp-tests/add-files-and-build.sh
25+
- name: Run inclusive language check
26+
if: success() || failure()
27+
run: sp-tests/check-inclusive-language.sh
28+
- name: Run link check
29+
if: success() || failure()
30+
run: sp-tests/check-links.sh
31+
- name: Run spelling check
32+
if: success() || failure()
33+
run: sp-tests/check-spelling.sh
34+
- name: Run styleguide check (expected to fail)
35+
continue-on-error: true
36+
if: success() || failure()
37+
run: sp-tests/check-styleguide.sh
38+
- name: Run accessibility check
39+
if: success() || failure()
40+
run: sp-tests/check-accessibility.sh
41+
- name: Clean up
42+
if: success() || failure()
43+
run: sp-tests/clean-up.sh
44+
test-docs:
45+
name: Test on docs folder
46+
runs-on: ubuntu-latest
47+
steps:
48+
- name: Check out repo
49+
uses: actions/checkout@v4
50+
- name: Run init and build
51+
env:
52+
default_filetype_choice: md # don't prompt for user choice
53+
run: sp-tests/run-init-and-build.sh docs
54+
- name: Add some files, build, and test
55+
run: sp-tests/add-files-and-build.sh docs
56+
- name: Run inclusive language check
57+
if: success() || failure()
58+
run: sp-tests/check-inclusive-language.sh docs
59+
- name: Run link check
60+
if: success() || failure()
61+
run: sp-tests/check-links.sh docs
62+
- name: Run spelling check
63+
if: success() || failure()
64+
run: sp-tests/check-spelling.sh docs
65+
- name: Run styleguide check (expected to fail)
66+
continue-on-error: true
67+
run: sp-tests/check-styleguide.sh docs
68+
- name: Run accessibility check
69+
if: success() || failure()
70+
run: sp-tests/check-accessibility.sh docs
71+
- name: Clean up
72+
if: success() || failure()
73+
run: sp-tests/clean-up.sh

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
testdir
2+
sp-docs/_build

.readthedocs.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sp-files/.readthedocs.yaml

.wokeignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sp-files/.wokeignore

0 commit comments

Comments
 (0)