[Merged by Bors] - GitHub Action: Check local Markdown links on push #2067

FlyingRatBull · 2021-05-01T09:12:37Z

Adds an GitHub Action to check all local (non http://, https:// ) links in all Markdown files of the repository for liveness.
Fails if a file is not found.

Goal

This should help maintaining the quality of the documentation.

Impact

Takes ~24 seconds currently and found 3 dead links (pull requests already created).

Dependent PRs

Info

See markdown-link-check.

Example output

FILE: ./docs/profiling.md

1 links checked.

FILE: ./docs/plugins_guidelines.md

37 links checked.

FILE: ./docs/linters.md
[✖] ../.github/linters/markdown-lint.yml → Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/.github/linters/markdown-lint.yml'] {
  errno: -2,
  code: 'ENOENT',
  syscall: 'access',
  path: '/github/workspace/.github/linters/markdown-lint.yml'
}

Improvements

Can also be used to check external links, but fails because of:
- Too many requests (429) responses:

FILE: ./CHANGELOG.md
[✖] https://github.com/bevyengine/bevy/pull/1762 → Status: 429

crates.io links respond 404

FILE: ./README.md
[✖] https://crates.io/crates/bevy → Status: 404

.github/workflows/action.yml

mockersf · 2021-05-01T11:49:06Z

Could you put this action into our existing CI workflow? https://github.com/bevyengine/bevy/blob/main/.github/workflows/ci.yml
And a check for it by job name in Bors config: https://github.com/bevyengine/bevy/blob/main/.github/bors.toml

For external links

Could you ignore links to GitHub instead of https links?
https://crates.io/crates/bevy is a 404 because of Crates.io returns 404 when not specifying Accept: text/html rust-lang/crates.io#788. Can you add the header? If not possible, all links to crates.io should be ignored

* Fix [404 on crates.io](rust-lang/crates.io#788) * Only block external checks on github.com

FlyingRatBull · 2021-05-01T12:07:49Z

I added external links to be checked, but for whatever reason, it gets stuck in a redirect loop for https://developer.android.com/distribute/best-practices/develop/target-sdk, which I cannot reproduce with curl/firefox:

[✖] https://developer.android.com/distribute/best-practices/develop/target-sdk → Status: 0 Error: Exceeded maxRedirects. Probably stuck in a redirect loop https://developer.android.com/distribute/best-practices/develop/target-sdk
    at Redirect.onResponse (/usr/local/lib/node_modules/markdown-link-check/node_modules/request/lib/redirect.js:98:27)
    at Request.onRequestResponse (/usr/local/lib/node_modules/markdown-link-check/node_modules/request/request.js:986:22)
    at ClientRequest.emit (node:events:365:28)
    at HTTPParser.parserOnIncomingClient [as onIncoming] (node:_http_client:621:27)
    at HTTPParser.parserOnHeadersComplete (node:_http_common:127:17)
    at TLSSocket.socketOnData (node:_http_client:487:22)
    at TLSSocket.emit (node:events:365:28)
    at addChunk (node:internal/streams/readable:314:12)
    at readableAddChunk (node:internal/streams/readable:289:9)
    at TLSSocket.Readable.push (node:internal/streams/readable:228:10)

Should I explicitly ignore this link in the markdown, in the configuration file or what would be the desired action for this?

I'll move the action into the ci.yml soon.

FlyingRatBull · 2021-05-01T12:18:35Z

I moved the action into ci.yml and referenced it in bors.toml.
The total runtime now is ~34 seconds and besides the links in the mentioned PRs and the on commented above, it all runs well.

mockersf · 2021-05-01T12:29:27Z

Should I explicitly ignore this link in the markdown, in the configuration file or what would be the desired action for this?

Not sure why it would fail, it's probably fine to ignore it unless someone else has an idea?

Small nit: I think the config file should go in https://github.com/bevyengine/bevy/tree/main/.github/linters. What do you think?

FlyingRatBull · 2021-05-01T12:48:51Z

Not sure why it would fail, it's probably fine to ignore it unless someone else has an idea?

I ignored it in the Markdown file as opposed to the configuration file because this way, if the link get's removed/changed, the ignore block can be reviewed as well.

Small nit: I think the config file should go in https://github.com/bevyengine/bevy/tree/main/.github/linters. What do you think?

Good idea. Moved it there and renamed it to markdown-link-check.json as well.

…2065)

FlyingRatBull · 2021-05-01T19:18:12Z

Can bors be triggered again? The new check should now succeed, now that the dependent PRs have been merged.

mockersf · 2021-05-01T19:20:27Z

you'll need to rebase your PR on main to fix the CI

FlyingRatBull · 2021-05-01T19:26:09Z

you'll need to rebase your PR on main to fix the CI

Thanks, will do

…2065)

* Fix [404 on crates.io](rust-lang/crates.io#788) * Only block external checks on github.com

FlyingRatBull · 2021-05-01T19:39:41Z

Sorry for the messy git - There was some confusion because of a duplicate broken link.

cart · 2021-05-02T20:01:44Z

bors r+

Adds an GitHub Action to check all local (non http://, https:// ) links in all Markdown files of the repository for liveness. Fails if a file is not found. # Goal This should help maintaining the quality of the documentation. # Impact Takes ~24 seconds currently and found 3 dead links (pull requests already created). # Dependent PRs * #2064 * #2065 * #2066 # Info See [markdown-link-check](https://github.com/marketplace/actions/markdown-link-check). # Example output ``` FILE: ./docs/profiling.md 1 links checked. FILE: ./docs/plugins_guidelines.md 37 links checked. FILE: ./docs/linters.md [✖] ../.github/linters/markdown-lint.yml → Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/.github/linters/markdown-lint.yml'] { errno: -2, code: 'ENOENT', syscall: 'access', path: '/github/workspace/.github/linters/markdown-lint.yml' } ``` # Improvements * Can also be used to check external links, but fails because of: * Too many requests (429) responses: ``` FILE: ./CHANGELOG.md [✖] #1762 → Status: 429 ``` * crates.io links respond 404 ``` FILE: ./README.md [✖] https://crates.io/crates/bevy → Status: 404 ```

bors · 2021-05-02T20:45:20Z

Pull request successfully merged into main.

Build succeeded:

Adds an GitHub Action to check all local (non http://, https:// ) links in all Markdown files of the repository for liveness. Fails if a file is not found. # Goal This should help maintaining the quality of the documentation. # Impact Takes ~24 seconds currently and found 3 dead links (pull requests already created). # Dependent PRs * bevyengine#2064 * bevyengine#2065 * bevyengine#2066 # Info See [markdown-link-check](https://github.com/marketplace/actions/markdown-link-check). # Example output ``` FILE: ./docs/profiling.md 1 links checked. FILE: ./docs/plugins_guidelines.md 37 links checked. FILE: ./docs/linters.md [✖] ../.github/linters/markdown-lint.yml → Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/.github/linters/markdown-lint.yml'] { errno: -2, code: 'ENOENT', syscall: 'access', path: '/github/workspace/.github/linters/markdown-lint.yml' } ``` # Improvements * Can also be used to check external links, but fails because of: * Too many requests (429) responses: ``` FILE: ./CHANGELOG.md [✖] bevyengine#1762 → Status: 429 ``` * crates.io links respond 404 ``` FILE: ./README.md [✖] https://crates.io/crates/bevy → Status: 404 ```

FlyingRatBull added 4 commits May 1, 2021 10:44

Add GitHub action to check links in Markdown files

b472782

Update action.yml

0253fe9

Create mlc_config.json

62d623a

Update action.yml

9d0ebf4

bjorn3 reviewed May 1, 2021

View reviewed changes

.github/workflows/action.yml Outdated Show resolved Hide resolved

Pin version 1.0.12 of gaurav-nelson/github-action-markdown-link-check

d5b7e80

mockersf added the A-Build-System Related to build systems or continuous integration label May 1, 2021

FlyingRatBull added 2 commits May 1, 2021 13:55

Update mlc_config.json

ee66c17

* Fix [404 on crates.io](rust-lang/crates.io#788) * Only block external checks on github.com

Update mlc_config.json

7676dff

FlyingRatBull added 3 commits May 1, 2021 14:14

Add check-markdown-links to ci.yml

1168389

Delete action.yml

1e41dc2

Add check-markdown-links to bors.toml

db38b5a

FlyingRatBull added 2 commits May 1, 2021 14:44

Moved markdown-link-check config

1666502

Ignore broken developer.android.com link in examples/README.md

8df3dd8

FlyingRatBull added 3 commits May 1, 2021 18:26

Fix broken link to .markdown-lint.yml in docs/linters.md (bevyengine#…

3c644bd

…2065)

Fix broken link to PBR example in README.md (bevyengine#2064)

4e5210f

Fix broken link to touch_input_events example (bevyengine#2066)

82014a3

FlyingRatBull added 5 commits May 1, 2021 21:28

Fix broken link to .markdown-lint.yml in docs/linters.md (bevyengine#…

5b8db27

…2065)

Fix broken link to PBR example in README.md (bevyengine#2064)

0d5afeb

Fix broken link to touch_input_events example (bevyengine#2066)

e7ede2e

Add GitHub action to check links in Markdown files

36e679c

Update action.yml

822c3fa

FlyingRatBull added 12 commits May 1, 2021 21:30

Create mlc_config.json

0458245

Update action.yml

d23997e

Pin version 1.0.12 of gaurav-nelson/github-action-markdown-link-check

75e5843

Update mlc_config.json

606a826

* Fix [404 on crates.io](rust-lang/crates.io#788) * Only block external checks on github.com

Update mlc_config.json

6269655

Add check-markdown-links to ci.yml

1d111b1

Delete action.yml

5facb67

Add check-markdown-links to bors.toml

7c42ec8

Moved markdown-link-check config

2c9bf36

Ignore broken developer.android.com link in examples/README.md

a5dac8e

Merge remote-tracking branch 'origin/main' into main

eb5e9f7

Fixed missing broken Markdown link

7d8ccea

MinerSebas approved these changes May 2, 2021

View reviewed changes

bors bot changed the title ~~GitHub Action: Check local Markdown links on push~~ [Merged by Bors] - GitHub Action: Check local Markdown links on push May 2, 2021

bors bot closed this May 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - GitHub Action: Check local Markdown links on push #2067

[Merged by Bors] - GitHub Action: Check local Markdown links on push #2067

FlyingRatBull commented May 1, 2021 •

edited

mockersf commented May 1, 2021

FlyingRatBull commented May 1, 2021

FlyingRatBull commented May 1, 2021

mockersf commented May 1, 2021

FlyingRatBull commented May 1, 2021

FlyingRatBull commented May 1, 2021

mockersf commented May 1, 2021

FlyingRatBull commented May 1, 2021

FlyingRatBull commented May 1, 2021

cart commented May 2, 2021

bors bot commented May 2, 2021

[Merged by Bors] - GitHub Action: Check local Markdown links on push #2067

[Merged by Bors] - GitHub Action: Check local Markdown links on push #2067

Conversation

FlyingRatBull commented May 1, 2021 • edited

Goal

Impact

Dependent PRs

Info

Example output

Improvements

mockersf commented May 1, 2021

FlyingRatBull commented May 1, 2021

FlyingRatBull commented May 1, 2021

mockersf commented May 1, 2021

FlyingRatBull commented May 1, 2021

FlyingRatBull commented May 1, 2021

mockersf commented May 1, 2021

FlyingRatBull commented May 1, 2021

FlyingRatBull commented May 1, 2021

cart commented May 2, 2021

bors bot commented May 2, 2021

FlyingRatBull commented May 1, 2021 •

edited