fix(docs): Added a GitHub action for markdown link check. #5997
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| name: Broken link report | ||
| about: Automated issue template for reporting link checker fails | ||
| title: Failing link check ({{ date | date('dddd, MMMM Do') }}) | ||
| labels: bug, automated issue, link check | ||
|
|
||
| --- | ||
|
|
||
| The broken link check failed. Check [the workflow logs](https://github.com/SeldonIO/testing-gitbook/actions/workflows/daily-link-checker.yml) to identify the failing links. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: Check all Markdown links daily | ||
|
There was a problem hiding this comment. As the main branch is not |
||
|
|
||
| on: | ||
|
There was a problem hiding this comment. should we also add manual trigger option and push on v2? |
||
| schedule: | ||
| - cron: "0 23 * * *" | ||
|
|
||
| permissions: | ||
| contents: read | ||
| issues: write | ||
|
|
||
| jobs: | ||
| markdown-link-check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@master | ||
|
|
||
| - name: Check links | ||
| uses: gaurav-nelson/github-action-markdown-link-check@v1 | ||
| with: | ||
| use-quiet-mode: 'yes' | ||
| use-verbose-mode: 'yes' | ||
| config-file: '.github/workflows/markdown.links.config.json' | ||
| folder-path: 'docs-gb' | ||
|
|
||
| - name: Create issue | ||
| if: ${{ failure() }} | ||
| uses: JasonEtco/create-an-issue@e27dddc79c92bc6e4562f268fffa5ed752639abd | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| filename: .github/ISSUE_TEMPLATE/broken_link_report.md | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| { | ||
|
There was a problem hiding this comment. could you explain the logic behind this file for review? |
||
| "replacementPatterns": [ | ||
| { | ||
| "pattern": ":currentVersion:", | ||
| "replacement": "latest" | ||
| }, | ||
| { | ||
| "pattern": "^/", | ||
| "replacement": "https://docs.seldon.ai/seldon-core-2/" | ||
| } | ||
| ], | ||
| "ignorePatterns": [ | ||
| { | ||
| "pattern": "^getting-started/" | ||
| }, | ||
| { | ||
| "pattern": "^production-environment/" | ||
| }, | ||
| { | ||
| "pattern": "^product-tour/" | ||
| }, | ||
| { | ||
| "pattern": "^demos/" | ||
| }, | ||
| { | ||
| "pattern": "^architecture/" | ||
| }, | ||
| { | ||
| "pattern": "^operations/" | ||
| }, | ||
| { | ||
| "pattern": "^upgrading/" | ||
| }, | ||
| { | ||
| "pattern": "^README.md" | ||
| }, | ||
| { | ||
| "pattern": "^multi-tentant-environment.md" | ||
| }, | ||
| { | ||
| "pattern": "^openshift-environment.md" | ||
| }, | ||
| { | ||
| "pattern": "^help-and-support/" | ||
| }, | ||
| { | ||
| "pattern": "^https?://localhost" | ||
| }, | ||
| { | ||
| "pattern": "^https://mvnrepository.com" | ||
| }, | ||
| { | ||
| "pattern": "^https://platform.openai.com/docs" | ||
| }, | ||
| { | ||
| "pattern": "^http://default-broker.seldon-logs" | ||
| }, | ||
| { | ||
| "pattern": "^https://www.tensorflow.org/tfx/serving/api_rest#request_format_2" | ||
| }, | ||
| { | ||
| "pattern": "^https://otexts.org/fpp2/holt-winters.html" | ||
| }, | ||
| { | ||
| "pattern": "^https://www.pcmag.com/encyclopedia" | ||
| }, | ||
| { | ||
| "pattern": "^https://www.microsoft.com/en-us/download/details.aspx?" | ||
| }, | ||
| { | ||
| "pattern": "^https://opensea.io/" | ||
| }, | ||
| { | ||
| "pattern": "^https://www.techopedia.com/definition/31996/hash-partitioning" | ||
| }, | ||
| { | ||
| "pattern": "^https://docs.github.com/" | ||
| }, | ||
| { | ||
| "pattern": "_template" | ||
| }, | ||
| { | ||
| "pattern": "^[#._]" | ||
| }, | ||
| ] | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should follow v2 title template:
fix(docs): ...