Skip to content

Commit

Permalink
Add CI
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Jan 17, 2024
1 parent 6c61553 commit 2e6262b
Show file tree
Hide file tree
Showing 5 changed files with 121 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/check_links.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
on:
push:
pull_request:
schedule:
- cron: "0 0 12 * *"

name: check-links

jobs:
check-links:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2

- name: Remove lines with false positives
run: |
sed -i 's/.*check_links.yaml.*//g' README.md
sed -i 's/.*check_spelling.yaml.*//g' README.md
# If there is a valid external link that fails,
# add it to mlc_config.json
- name: External links must be checked, do not allow '0' in the 'aliveStatusCodes' of mlc_config.json
run: if [[ $(grep --regexp "[^0-9]0[^0-9]" mlc_config.json | wc --lines) == "1" ]]; then echo "FOUND"; exit 42; fi

- name: Internal links must checked, do not allow '400' in the 'aliveStatusCodes' of mlc_config.json
run: if [[ $(grep --regexp "[^0-9]400[^0-9]" mlc_config.json | wc --lines) == "1" ]]; then echo "FOUND"; exit 42; fi

- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: 'mlc_config.json'
28 changes: 28 additions & 0 deletions .github/workflows/check_spelling.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Check that there is correct spelling in all files
name: Check spelling

on:
push:
pull_request:
schedule:
- cron: "0 0 16 * *"


jobs:
check_spelling:

runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:

- name: Set up Git repository
uses: actions/checkout@v2

- name: Remove folders that do not care about spelling
run: |
rm -rf development_design
rm -rf projects
rm -rf feedback
- uses: igsekor/[email protected]
45 changes: 45 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
matrix:
- name: markdown
dictionary:
wordlists:
- .wordlist.txt
output: wordlist.dic
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.extra:
- pyspelling.filters.html:
comments: false
attributes:
- alt
ignores:
- ':matches(code, pre)'
- 'code'
- 'pre'
- 'blockquote'
sources:
- '**/*.md'
default_encoding: utf-8
- name: Quarto markdown
dictionary:
wordlists:
- .wordlist.txt
output: wordlist.dic
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.extra:
- pyspelling.filters.html:
comments: false
attributes:
- alt
ignores:
- ':matches(code, pre)'
- 'code'
- 'pre'
- 'blockquote'
sources:
- '**/*.md'
default_encoding: utf-8
2 changes: 2 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Richel

14 changes: 14 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"aliveStatusCodes": [200, 403, 418, 503],
"ignorePatterns": [
{
"pattern": "^morning_session/overview/$"
},
{
"pattern": "^https://bianca.uppmax.uu.se"
},
{
"pattern": "^https://rackham-gui.uppmax.uu.se"
}
]
}

0 comments on commit 2e6262b

Please sign in to comment.