Skip to content

Commit

Permalink
More CI
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Jun 13, 2024
1 parent 4a5a844 commit 33415b7
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/check_markdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Check that there is correct markdown in all files
name: Check markdown

# Check spelling on the 21st day of the month.
# 21st as the first letter of this repo is the 21st letter in the alphabet.
on:
push:
pull_request:
schedule:
- cron: "0 0 21 * *"

jobs:
check_markdown:

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

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

- uses: articulate/actions-markdownlint@v1
with:
config: .markdownlint.jsonc
ignore: .markdownlintignore

6 changes: 6 additions & 0 deletions .github/workflows/valid_json_schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"properties": {
"foo": { "type": "string" },
"bar": { "type": "number" }
}
}
6 changes: 6 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Example markdownlint configuration with all properties set to their default value
{

// Default state for all rules
"default": true
}
2 changes: 2 additions & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
docs/index.md
docs/software/software-table.md
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,16 @@ Sure, just add an Issue. Or send an email.

* [BEAST2 GitHub](https://github.com/CompEvol/beast2)

## Files used by continuous integration scripts

Filename |Descriptions
--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------
[mlc_config.json](mlc_config.json) |Configuration of the link checker, use `markdown-link-check --config mlc_config.json --quiet docs/**/*.md` to do link checking locally
[.spellcheck.yml](.spellcheck.yml) |Configuration of the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally
[.wordlist.txt](.wordlist.txt) |Whitelisted words for the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally
[.markdownlint.jsonc](.markdownlint.jsonc)|Configuration of the markdown linter, use `markdownlint "**/*.md"` to do markdown linting locally. The name of this file is a default name.
[.markdownlintignore](.markdownlintignore)|Files ignored by the markdown linter, use `markdownlint "**/*.md"` to do markdown linting locally. The name of this file is a default name.

## References

Article about `babette`:
Expand Down

0 comments on commit 33415b7

Please sign in to comment.