From eb3deb96c3f200649d9b3c825d8492555c38829a Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Fri, 4 Dec 2020 20:24:33 +0000 Subject: [PATCH 1/7] Update markdown test tools Signed-off-by: Reece Dunham --- test/common/markdown/markdown-link.tests.ps1 | 2 +- test/common/markdown/package.json | 4 +-- test/common/markdown/yarn.lock | 35 ++++++++------------ 3 files changed, 17 insertions(+), 24 deletions(-) diff --git a/test/common/markdown/markdown-link.tests.ps1 b/test/common/markdown/markdown-link.tests.ps1 index 21c3632b530..0ef50e58de8 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.3 } } diff --git a/test/common/markdown/package.json b/test/common/markdown/package.json index cefe4fd4b90..2139176da20 100644 --- a/test/common/markdown/package.json +++ b/test/common/markdown/package.json @@ -6,11 +6,11 @@ "main": "gulpfile.js", "dependencies": { "gulp": "^4.0.2", - "markdownlint": "^0.21.0", + "markdownlint": "^0.22.0", "through2": "^4.0.2" }, "resolutions": { - "yargs-parser": "^13.1.2" , + "yargs-parser": "^13.1.2", "y18n": "^5.0.5" }, "devDependencies": { diff --git a/test/common/markdown/yarn.lock b/test/common/markdown/yarn.lock index 1d86b0465ce..b8ba175abb9 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" From 3a87aa50e3b9a55946b9d10572f5dd2df18275f3 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Sat, 5 Dec 2020 12:07:49 -0500 Subject: [PATCH 2/7] 3.8.4 --- test/common/markdown/markdown-link.tests.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/common/markdown/markdown-link.tests.ps1 b/test/common/markdown/markdown-link.tests.ps1 index 0ef50e58de8..2fe6d32d8ce 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.8.3 + sudo yarn global add markdown-link-check@3.8.4 } } From f8d7d0782189e93cf28a6afffbbe6df6709ddf1a Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Wed, 9 Dec 2020 17:10:28 +0000 Subject: [PATCH 3/7] Update docs, retry flag --- .github/CONTRIBUTING.md | 6 +++--- test/common/markdown/markdown-link.tests.ps1 | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8548101590f..d6d78e52fb7 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/test/common/markdown/markdown-link.tests.ps1 b/test/common/markdown/markdown-link.tests.ps1 index 2fe6d32d8ce..f6e2e95810c 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.8.4 + 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 @@ -98,6 +98,7 @@ Describe "Verify Markdown Links" { # there could be multiple reasons why a failure is ok # check against the allowed failures $allowedFailures = [System.Net.HttpStatusCode[]]( + 429, # Rate limited 503, # Service Unavailable 504 # Gateway Timeout ) From d092102d6f4377dd070a16a560ee5eca96abb879 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Wed, 9 Dec 2020 17:33:47 +0000 Subject: [PATCH 4/7] Fix actual dead links Signed-off-by: Reece Dunham --- docs/community/governance.md | 2 +- docs/maintainers/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/community/governance.md b/docs/community/governance.md index 5b93ddeec51..174f7b0cd2c 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/managing-access-to-your-organizations-repositories) 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 2cafeb94888..3091b2bec85 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/managing-access-to-your-organizations-repositories) 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/) From 1791131ecd9a360317649100151f1b35ec5c2197 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Tue, 15 Dec 2020 16:46:37 +0000 Subject: [PATCH 5/7] Experiment with removing 429 from allowed failures --- test/common/markdown/markdown-link.tests.ps1 | 1 - 1 file changed, 1 deletion(-) diff --git a/test/common/markdown/markdown-link.tests.ps1 b/test/common/markdown/markdown-link.tests.ps1 index f6e2e95810c..c9a7a8789cd 100644 --- a/test/common/markdown/markdown-link.tests.ps1 +++ b/test/common/markdown/markdown-link.tests.ps1 @@ -98,7 +98,6 @@ Describe "Verify Markdown Links" { # there could be multiple reasons why a failure is ok # check against the allowed failures $allowedFailures = [System.Net.HttpStatusCode[]]( - 429, # Rate limited 503, # Service Unavailable 504 # Gateway Timeout ) From 973748b5e9483b4a3bae013de948c67c783baf39 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Thu, 24 Dec 2020 12:05:29 -0500 Subject: [PATCH 6/7] Update links --- docs/community/governance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/community/governance.md b/docs/community/governance.md index 174f7b0cd2c..d32cceb393f 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://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories) 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)). From e35aa83fca90aaa683e466e925b7ffc87848bf37 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Thu, 24 Dec 2020 12:05:49 -0500 Subject: [PATCH 7/7] Update links --- docs/maintainers/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainers/README.md b/docs/maintainers/README.md index 3091b2bec85..0c28e2cc9de 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://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories) 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/)