Skip to content

Commit

Permalink
ci(GITHUB): update markdown testing action
Browse files Browse the repository at this point in the history
  • Loading branch information
niall-byrne committed Mar 10, 2023
1 parent 1e78368 commit c228fb1
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 12 deletions.
7 changes: 0 additions & 7 deletions .github/config/markdown.link.check.json

This file was deleted.

9 changes: 5 additions & 4 deletions .github/workflows/self-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -307,18 +307,19 @@ jobs:
env:
WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}

- name: Documentation Test -- Check Markdown Links For Readme
uses: gaurav-nelson/github-action-markdown-link-check@1.0.14
- name: Documentation Test -- Check Markdown Links For Template
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: 'template/.github/config/markdown.link.check.json'
config-file: 'template/{{cookiecutter.profile_slug}}/.github/config/markdown.link.check.json'
use-quiet-mode: 'no'
use-verbose-mode: 'yes'
folder-path: 'template, template/.github/workflows'
max-depth: 1

- name: Documentation Test -- Check Markdown Links For Rendered Template
uses: gaurav-nelson/github-action-markdown-link-check@1.0.14
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: 'template/{{cookiecutter.profile_slug}}/.github/config/markdown.link.check.json'
use-quiet-mode: 'no'
use-verbose-mode: 'yes'
folder-path: ${{ env.TEMPLATED_NAME }}
Expand Down
2 changes: 1 addition & 1 deletion cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"_GITHUB_CI_PYTHON_VERSION": "3.9",
"_GITHUB_ACTION_CACHE": "actions/cache@v3",
"_GITHUB_ACTION_CHECKOUT": "actions/checkout@v3",
"_GITHUB_ACTION_MARKDOWN_LINK_CHECK": "gaurav-nelson/github-action-markdown-link-check@1.0.14",
"_GITHUB_ACTION_MARKDOWN_LINK_CHECK": "gaurav-nelson/github-action-markdown-link-check@v1",
"_GITHUB_ACTION_PYTHON": "actions/setup-python@v4",
"_GITHUB_ACTION_TRUFFLEHOG": "trufflesecurity/[email protected]",
"_GITHUB_ACTION_YAMLLINT": "ibiqlik/action-yamllint@v3"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"httpHeaders": [
{
"urls": [
"https://github.com/",
"https://guides.github.com/",
"https://help.github.com/",
"https://docs.github.com/"
],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
],
"ignorePatterns": [
{
"pattern": "^https://github.com/{{cookiecutter.github_handle}}/{{cookiecutter.profile_slug}}/"
}
]
}
1 change: 1 addition & 0 deletions {{cookiecutter.profile_slug}}/.github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ jobs:
- name: Documentation Test -- Documentation Validation
uses: {% endraw %}{{ cookiecutter._GITHUB_ACTION_MARKDOWN_LINK_CHECK }}{% raw %}
with:
config-file: '.github/config/markdown.link.check.json'
use-quiet-mode: 'no'
use-verbose-mode: 'yes'

Expand Down

0 comments on commit c228fb1

Please sign in to comment.