Skip to content

Commit 4a09585

Browse files
RDILRDIL
authored
Update markdown test tools (#14325)
* Update markdown test tools * Update docs, retry flag * Fix actual dead links * Update links
1 parent 9ea718f commit 4a09585

6 files changed

Lines changed: 22 additions & 29 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ which can be run in interactive mode to correct typos or add words to the ignore
8282

8383
To run the spellchecker, follow these steps:
8484

85-
* install [Node.js](https://nodejs.org/en/) (v6.4.0 or up)
85+
* install [Node.js](https://nodejs.org/en/) (v10 or up)
8686
* install [markdown-spellcheck](https://github.com/lukeapage/node-markdown-spellcheck) by
8787
`npm install -g markdown-spellcheck` (v0.11.0 or up)
8888
* run `mdspell "**/*.md" --ignore-numbers --ignore-acronyms --en-us`
@@ -96,9 +96,9 @@ which can be run to see if any links are dead.
9696

9797
To run the link-checker, follow these steps:
9898

99-
* install [Node.js](https://nodejs.org/en/) (v6.4.0 or up)
99+
* install [Node.js](https://nodejs.org/en/) (v10 or up)
100100
* install markdown-link-check by
101-
`npm install -g markdown-link-check@3.7.2` (v3.7.2 **only**)
101+
`npm install -g markdown-link-check@3.8.5`
102102
* run `find . \*.md -exec markdown-link-check {} \;`
103103

104104
## Contributing to Code

‎docs/community/governance.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ For more information on Repository Maintainers--their responsibilities, who they
9494

9595
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.
9696

97-
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:
97+
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:
9898

9999
1. `git push` to all branches *except* `master`.
100100
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)).

‎docs/maintainers/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Repository Maintainers are trusted stewards of the PowerShell repository responsible for maintaining consistency and quality of PowerShell code.
44
One of their primary responsibilities is merging pull requests after all requirements have been fulfilled.
55

6-
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:
6+
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:
77

88
1. `git push` to the official PowerShell repository
99
1. Merge [pull requests](https://www.thinkful.com/learn/github-pull-request-tutorial/)

‎test/common/markdown/markdown-link.tests.ps1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Describe "Verify Markdown Links" {
77
{
88
Write-Verbose "installing markdown-link-check ..." -Verbose
99
start-nativeExecution {
10-
sudo yarn global add markdown-link-check@3.7.2
10+
sudo yarn global add markdown-link-check@3.8.5
1111
}
1212
}
1313

@@ -36,7 +36,7 @@ Describe "Verify Markdown Links" {
3636
param([object] $group)
3737
foreach($file in $group.Group)
3838
{
39-
$results = markdown-link-check $file 2>&1
39+
$results = markdown-link-check -r $file 2>&1
4040
Write-Output ([PSCustomObject]@{
4141
file = $file
4242
results = $results

‎test/common/markdown/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"main": "gulpfile.js",
77
"dependencies": {
88
"gulp": "^4.0.2",
9-
"markdownlint": "^0.21.0",
9+
"markdownlint": "^0.22.0",
1010
"through2": "^4.0.2"
1111
},
1212
"resolutions": {

‎test/common/markdown/yarn.lock‎

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,10 @@ archy@^1.0.0:
5353
resolved "https://registry.yarnpkg.com/archy/-/archy-1.0.0.tgz"
5454
integrity sha1-+cjBN1fMHde8N5rHeyxipcKGjEA=
5555

56-
argparse@^1.0.7:
57-
version "1.0.10"
58-
resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz"
59-
integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==
60-
dependencies:
61-
sprintf-js "~1.0.2"
56+
argparse@^2.0.1:
57+
version "2.0.1"
58+
resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
59+
integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
6260

6361
arr-diff@^4.0.0:
6462
version "4.0.0"
@@ -1346,23 +1344,23 @@ map-visit@^1.0.0:
13461344
dependencies:
13471345
object-visit "^1.0.0"
13481346

1349-
markdown-it@11.0.0:
1350-
version "11.0.0"
1351-
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-11.0.0.tgz"
1352-
integrity sha512-+CvOnmbSubmQFSA9dKz1BRiaSMV7rhexl3sngKqFyXSagoA3fBdJQ8oZWtRy2knXdpDXaBw44euz37DeJQ9asg==
1347+
markdown-it@12.0.2:
1348+
version "12.0.2"
1349+
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-12.0.2.tgz#4401beae8df8aa2221fc6565a7188e60a06ef0ed"
1350+
integrity sha512-4Lkvjbv2kK+moL9TbeV+6/NHx+1Q+R/NIdUlFlkqkkzUcTod4uiyTJRiBidKR9qXSdkNFkgv+AELY8KN9vSgVA==
13531351
dependencies:
1354-
argparse "^1.0.7"
1352+
argparse "^2.0.1"
13551353
entities "~2.0.0"
13561354
linkify-it "^3.0.1"
13571355
mdurl "^1.0.1"
13581356
uc.micro "^1.0.5"
13591357

1360-
markdownlint@^0.21.0:
1361-
version "0.21.1"
1362-
resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.21.1.tgz"
1363-
integrity sha512-8kc88w5dyEzlmOWIElp8J17qBgzouOQfJ0LhCcpBFrwgyYK6JTKvILsk4FCEkiNqHkTxwxopT2RS2DYb/10qqg==
1358+
markdownlint@^0.22.0:
1359+
version "0.22.0"
1360+
resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.22.0.tgz#4ed95b61c17ae9f4dfca6a01f038c744846c0a72"
1361+
integrity sha512-J4B+iMc12pOdp/wfYi03W2qfAfEyiZzq3qvQh/8vOMNU8vXYY6Jg440EY7dWTBCqROhb1i4nAn3BTByJ5kdx1w==
13641362
dependencies:
1365-
markdown-it "11.0.0"
1363+
markdown-it "12.0.2"
13661364

13671365
matchdep@^2.0.0:
13681366
version "2.0.0"
@@ -1994,11 +1992,6 @@ split-string@^3.0.1, split-string@^3.0.2:
19941992
dependencies:
19951993
extend-shallow "^3.0.0"
19961994

1997-
sprintf-js@~1.0.2:
1998-
version "1.0.3"
1999-
resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz"
2000-
integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=
2001-
20021995
stack-trace@0.0.10:
20031996
version "0.0.10"
20041997
resolved "https://registry.yarnpkg.com/stack-trace/-/stack-trace-0.0.10.tgz"

0 commit comments

Comments
 (0)