Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Commit

Permalink
ci: typos and check links (#3)
Browse files Browse the repository at this point in the history
* ci: typos and check links

* fix: typos

* ci: typos
  • Loading branch information
storopoli committed Jan 8, 2024
1 parent 8ecf984 commit 6ce515b
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 2 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Markdown Links Check
# runs every monday at 9 am
on:
schedule:
- cron: "0 9 * * 1"
workflow_dispatch: null

jobs:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: "yes"
use-verbose-mode: "yes"
config-file: ".mlc_config.json"
file-path: "./README.md, ./LICENSE, ./index.qmd"
22 changes: 22 additions & 0 deletions .github/workflows/typos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Check Typos
on:
push:
branches:
- master
- main
pull_request:
branches:
- master
- main
workflow_dispatch: null

jobs:
run:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4

- name: Check spelling
uses: crate-ci/typos@master
25 changes: 25 additions & 0 deletions .mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"aliveStatusCodes": [403, 200, 206],
"httpHeaders": [
{
"urls": [
"https://github.com/",
"https://guides.github.com/",
"https://help.github.com/",
"https://docs.github.com/"
],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
],
"retryOn429": true,
"ignorePatterns": [
{
"pattern": "../.*"
},
{
"pattern": "/github/workspace/.*"
}
]
}
10 changes: 10 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[default]
extend-ignore-re = [
"\\b[0-9A-Za-z+/]{91}(=|==)?\\b", # base64 strings
"[0-9a-fA-F]{7,}", # git commit hashes
"\\b[0-9A-Za-z+/]{33,}(=|==)?\\b", # SHA/tpub/adresses etc strings
]

[type.gitignore]
check-file = false
extend-glob = [".gitignore"]
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ Or in BibTeX format (LaTeX):

## License

This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 Internacional](http://creativecommons.org/licenses/by-sa/4.0/).
This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).

[![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)
2 changes: 1 addition & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ The syntax is quite similar to Python.

. . .

But, no identation and every keyword needs an `end`.
But, no indentation and every keyword needs an `end`.

. . .

Expand Down

0 comments on commit 6ce515b

Please sign in to comment.