Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

tests: add markdown link checker #11358

Merged
merged 25 commits into from
Sep 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
1096aac
Added markdown links checker
andreizet Sep 1, 2020
d21ba74
Removed wrongly opened parenthesis from docs/readme.md
andreizet Sep 1, 2020
ee91506
Check links in root readme.md
andreizet Sep 1, 2020
ad9a004
Ignore the workflow badge when checking urls
andreizet Sep 1, 2020
78384d4
Moved links checking to a separate yml
andreizet Sep 3, 2020
d9eaa8c
Moved links checking to a separate yml
andreizet Sep 3, 2020
27899fa
Check links only for pull requests
andreizet Sep 3, 2020
1ee0d9a
Run checklinks actions sequentially
andreizet Sep 3, 2020
3af365e
Merged markdown links check into a single job
andreizet Sep 3, 2020
ee10b16
- Changed workflow's name
andreizet Sep 3, 2020
a069c96
- Added cron schedule
andreizet Sep 3, 2020
8a6a550
- Added cron schedule
andreizet Sep 3, 2020
5517211
- Added cron schedule
andreizet Sep 3, 2020
1fb89d3
Added cron schedule
andreizet Sep 3, 2020
15cbf96
Markdown Link Check: Run only on push
andreizet Sep 4, 2020
9bc1a6e
Markdown Link Check: Run only on push
andreizet Sep 4, 2020
0bf13f2
Markdown links check: ignore commits & pull requests links
andreizet Sep 4, 2020
d033137
Check only readme.md from root
andreizet Sep 4, 2020
5a4b672
Check links without sleeping between
andreizet Sep 4, 2020
89a16a6
Markdown links check: added comments
andreizet Sep 4, 2020
5acdd48
Markdown links check: removed on push, added on schedule
andreizet Sep 4, 2020
050a827
Markdown links check: removed working links from ignore list
andreizet Sep 4, 2020
e9391f3
Markdown links check: modified comments
andreizet Sep 4, 2020
6d14ca3
Moved markdown.links.config.json to .github/workflows/
andreizet Sep 10, 2020
638c289
Removed links checking on push
andreizet Sep 10, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/check-md-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Markdown Links Check
# runs every monday at 9 am
on:
schedule:
- cron: "0 9 * * 1"

jobs:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
# checks all markdown files from /docs including all subfolders
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.github/workflows/markdown.links.config.json'
folder-path: 'docs/'
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
# checks all markdown files from root but ignores subfolders
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.github/workflows/markdown.links.config.json'
max-depth: 0
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ jobs:
- run: sudo apt-get install xvfb
- name: Run smoke tests
run: xvfb-run --auto-servernum yarn smoke --debug -j=1 --retries=2 --invert-match ${{ matrix.smoke-test-invert }} $SMOKE_GROUP_1

# Only run smoke tests for windows against stable chrome.
smoke-windows:
runs-on: windows-latest
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/markdown.links.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"ignorePatterns": [
{
"pattern": "^http://www.tmeter.ru"
},
{
"pattern": "https://github.com/GoogleChrome/lighthouse/workflows/\uD83D\uDCA1\uD83C\uDFE0/badge.svg"
}
]
}
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ $ lighthouse --port=9222 --emulated-form-factor=none --throttling.cpuSlowdownMul

## Lighthouse as trace processor

Lighthouse can be used to analyze trace and performance data collected from other tools (like WebPageTest and ChromeDriver). The `traces` and `devtoolsLogs` artifact items can be provided using a string for the absolute path on disk if they're saved with `.trace.json` and `.devtoolslog.json` file extensions, respectively. The `devtoolsLogs` array is captured from the `Network` and `Page` domains (a la ChromeDriver's [enableNetwork and enablePage options]((https://sites.google.com/a/chromium.org/chromedriver/capabilities#TOC-perfLoggingPrefs-object)).
Lighthouse can be used to analyze trace and performance data collected from other tools (like WebPageTest and ChromeDriver). The `traces` and `devtoolsLogs` artifact items can be provided using a string for the absolute path on disk if they're saved with `.trace.json` and `.devtoolslog.json` file extensions, respectively. The `devtoolsLogs` array is captured from the `Network` and `Page` domains (a la ChromeDriver's [enableNetwork and enablePage options](https://sites.google.com/a/chromium.org/chromedriver/capabilities#TOC-perfLoggingPrefs-object)).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems that a wrongly opened parenthesis was messing up the link. This link was not even transformed by github: https://github.com/GoogleChrome/lighthouse/blob/master/docs/readme.md

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! this is exactly the kind of thing I wanted to catch.


As an example, here's a trace-only run that reports on user timings and critical request chains:

Expand Down