From 4a09585fe72c3679e23a1aa047b23ac827609c55 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Mon, 11 Jan 2021 22:58:19 -0500 Subject: [PATCH] Update markdown test tools (#14325) * Update markdown test tools * Update docs, retry flag * Fix actual dead links * Update links --- .github/CONTRIBUTING.md | 6 ++-- docs/community/governance.md | 2 +- docs/maintainers/README.md | 2 +- test/common/markdown/markdown-link.tests.ps1 | 4 +-- test/common/markdown/package.json | 2 +- test/common/markdown/yarn.lock | 35 ++++++++------------ 6 files changed, 22 insertions(+), 29 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8548101590..d6d78e52fb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -82,7 +82,7 @@ which can be run in interactive mode to correct typos or add words to the ignore To run the spellchecker, follow these steps: -* install [Node.js](https://nodejs.org/en/) (v6.4.0 or up) +* install [Node.js](https://nodejs.org/en/) (v10 or up) * install [markdown-spellcheck](https://github.com/lukeapage/node-markdown-spellcheck) by `npm install -g markdown-spellcheck` (v0.11.0 or up) * run `mdspell "**/*.md" --ignore-numbers --ignore-acronyms --en-us` @@ -96,9 +96,9 @@ which can be run to see if any links are dead. To run the link-checker, follow these steps: -* install [Node.js](https://nodejs.org/en/) (v6.4.0 or up) +* install [Node.js](https://nodejs.org/en/) (v10 or up) * install markdown-link-check by - `npm install -g markdown-link-check@3.7.2` (v3.7.2 **only**) + `npm install -g markdown-link-check@3.8.5` * run `find . \*.md -exec markdown-link-check {} \;` ## Contributing to Code diff --git a/docs/community/governance.md b/docs/community/governance.md index 5b93ddeec5..d32cceb393 100644 --- a/docs/community/governance.md +++ b/docs/community/governance.md @@ -94,7 +94,7 @@ For more information on Repository Maintainers--their responsibilities, who they Area Experts are people with knowledge of specific components or technologies in the PowerShell domain. They are responsible for code reviews, issue triage, and providing their expertise to others. -They have [write access](https://help.github.com/articles/permission-levels-for-an-organization-repository/) to the PowerShell repository which gives them the power to: +They have [write access](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization) to the PowerShell repository which gives them the power to: 1. `git push` to all branches *except* `master`. 1. Merge pull requests to all branches *except* `master` (though this should not be common given that [`master`is the only long-living branch](../git/README.md#understand-branches)). diff --git a/docs/maintainers/README.md b/docs/maintainers/README.md index 2cafeb9488..0c28e2cc9d 100644 --- a/docs/maintainers/README.md +++ b/docs/maintainers/README.md @@ -3,7 +3,7 @@ Repository Maintainers are trusted stewards of the PowerShell repository responsible for maintaining consistency and quality of PowerShell code. One of their primary responsibilities is merging pull requests after all requirements have been fulfilled. -They have [write access](https://help.github.com/articles/repository-permission-levels-for-an-organization/) to the PowerShell repositories which gives them the power to: +They have [write access](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization) to the PowerShell repositories which gives them the power to: 1. `git push` to the official PowerShell repository 1. Merge [pull requests](https://www.thinkful.com/learn/github-pull-request-tutorial/) diff --git a/test/common/markdown/markdown-link.tests.ps1 b/test/common/markdown/markdown-link.tests.ps1 index 21c3632b53..c9a7a8789c 100644 --- a/test/common/markdown/markdown-link.tests.ps1 +++ b/test/common/markdown/markdown-link.tests.ps1 @@ -7,7 +7,7 @@ Describe "Verify Markdown Links" { { Write-Verbose "installing markdown-link-check ..." -Verbose start-nativeExecution { - sudo yarn global add markdown-link-check@3.7.2 + sudo yarn global add markdown-link-check@3.8.5 } } @@ -36,7 +36,7 @@ Describe "Verify Markdown Links" { param([object] $group) foreach($file in $group.Group) { - $results = markdown-link-check $file 2>&1 + $results = markdown-link-check -r $file 2>&1 Write-Output ([PSCustomObject]@{ file = $file results = $results diff --git a/test/common/markdown/package.json b/test/common/markdown/package.json index ea066f7cb0..cbf2a95885 100644 --- a/test/common/markdown/package.json +++ b/test/common/markdown/package.json @@ -6,7 +6,7 @@ "main": "gulpfile.js", "dependencies": { "gulp": "^4.0.2", - "markdownlint": "^0.21.0", + "markdownlint": "^0.22.0", "through2": "^4.0.2" }, "resolutions": { diff --git a/test/common/markdown/yarn.lock b/test/common/markdown/yarn.lock index 1d86b0465c..b8ba175abb 100644 --- a/test/common/markdown/yarn.lock +++ b/test/common/markdown/yarn.lock @@ -53,12 +53,10 @@ archy@^1.0.0: resolved "https://registry.yarnpkg.com/archy/-/archy-1.0.0.tgz" integrity sha1-+cjBN1fMHde8N5rHeyxipcKGjEA= -argparse@^1.0.7: - version "1.0.10" - resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz" - integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== - dependencies: - sprintf-js "~1.0.2" +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== arr-diff@^4.0.0: version "4.0.0" @@ -1346,23 +1344,23 @@ map-visit@^1.0.0: dependencies: object-visit "^1.0.0" -markdown-it@11.0.0: - version "11.0.0" - resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-11.0.0.tgz" - integrity sha512-+CvOnmbSubmQFSA9dKz1BRiaSMV7rhexl3sngKqFyXSagoA3fBdJQ8oZWtRy2knXdpDXaBw44euz37DeJQ9asg== +markdown-it@12.0.2: + version "12.0.2" + resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-12.0.2.tgz#4401beae8df8aa2221fc6565a7188e60a06ef0ed" + integrity sha512-4Lkvjbv2kK+moL9TbeV+6/NHx+1Q+R/NIdUlFlkqkkzUcTod4uiyTJRiBidKR9qXSdkNFkgv+AELY8KN9vSgVA== dependencies: - argparse "^1.0.7" + argparse "^2.0.1" entities "~2.0.0" linkify-it "^3.0.1" mdurl "^1.0.1" uc.micro "^1.0.5" -markdownlint@^0.21.0: - version "0.21.1" - resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.21.1.tgz" - integrity sha512-8kc88w5dyEzlmOWIElp8J17qBgzouOQfJ0LhCcpBFrwgyYK6JTKvILsk4FCEkiNqHkTxwxopT2RS2DYb/10qqg== +markdownlint@^0.22.0: + version "0.22.0" + resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.22.0.tgz#4ed95b61c17ae9f4dfca6a01f038c744846c0a72" + integrity sha512-J4B+iMc12pOdp/wfYi03W2qfAfEyiZzq3qvQh/8vOMNU8vXYY6Jg440EY7dWTBCqROhb1i4nAn3BTByJ5kdx1w== dependencies: - markdown-it "11.0.0" + markdown-it "12.0.2" matchdep@^2.0.0: version "2.0.0" @@ -1994,11 +1992,6 @@ split-string@^3.0.1, split-string@^3.0.2: dependencies: extend-shallow "^3.0.0" -sprintf-js@~1.0.2: - version "1.0.3" - resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz" - integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw= - stack-trace@0.0.10: version "0.0.10" resolved "https://registry.yarnpkg.com/stack-trace/-/stack-trace-0.0.10.tgz"