forked from InsertKoinIO/koin
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GitHub Action's linter to check markdown files and remove invalid…
… links When a pr is opened the linter will run over all md files and check if a link is not valid. # Notes: - Some md files were removed because I couldn't file a redirection to them: - deleted: coverpage.md - deleted: developer-guides/android-developer-guide.md - deleted: developer-guides/samples.md - deleted: ../start/coverpage.md - The removed link were removed from the doc, it doesn't makes sense have an invalid link. For example: - https://www.ekito.fr/people/sparkjava-and-koin/ - https://medium.com/mindorks/using-dependency-injection-with-koin-bee0b461714a - Config Files comments: - CHANGELOG.md is excluded from the linter. It contains a lot of github links, so when the linter checks it, GitHub returns a max requests reached error (429 HTTP error code). The [linter library is adding a feature to fix this case. However, they have to release a new version with this feature](tcort/markdown-link-check#114). - https://developer.android.com/ links are removed from the check because it requires authentication, so they fail due to an redirect loop.
- Loading branch information
Showing
11 changed files
with
66 additions
and
325 deletions.
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,7 @@ | ||
{ | ||
"ignorePatterns": [ | ||
{ | ||
"pattern": "^https://developer.android.com" | ||
} | ||
] | ||
} |
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,16 @@ | ||
name: Check Markdown links | ||
on: pull_request | ||
jobs: | ||
markdown-link-check: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@master | ||
- uses: gaurav-nelson/github-action-markdown-link-check@v1 | ||
with: | ||
use-verbose-mode: 'yes' | ||
config-file: '.config/mlc_config.json' | ||
# CHANGELOG.md is excluded. | ||
# GitHub returns 429 error code due to the amount of requests. | ||
# This will be fixed after https://github.com/tcort/markdown-link-check/issues/114 be released | ||
folder-path: 'koin-projects, .github' | ||
file-path: './README.md, ./CODE_OF_CONDUCT.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 |
---|---|---|
|
@@ -8,5 +8,3 @@ classes/ | |
.DS_Store | ||
/build | ||
/captures | ||
|
||
|
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
This file was deleted.
Oops, something went wrong.
241 changes: 0 additions & 241 deletions
241
koin-projects/docs/reference/developer-guides/android-developer-guide.md
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.