Skip to content

Update markdown test tools - #14325

Merged
Ilya (iSazonov) merged 8 commits into
PowerShell:masterfrom
RDIL:master
Jan 12, 2021
Merged

Update markdown test tools#14325
Ilya (iSazonov) merged 8 commits into
PowerShell:masterfrom
RDIL:master

Conversation

@RDIL

Copy link
Copy Markdown
Contributor

Signed-off-by: Reece Dunham me@rdil.rocks

PR Summary

  • Update the external markdown testing tools to the latest version

PR Context

Staying somewhat up-to-date

PR Checklist

@xtqqczze

xtqqczze commented Dec 5, 2020

Copy link
Copy Markdown
Contributor
2020-12-04T21:26:40.2433904Z       [-] https://github.com/powershell/powershell-rfc → Status: 429 should work 60.18s
2020-12-04T21:26:40.2467358Z         RuntimeException: Failed to complete request to "https://github.com/powershell/powershell-rfc → Status: 429". Response status code does not indicate success: 404 (Not Found).
2020-12-04T21:26:40.2469184Z         at <ScriptBlock>, /home/vsts/work/1/s/test/common/markdown/markdown-link.tests.ps1: line 119

HTTP 429 -> Too many requests

Related upstream issue: tcort/markdown-link-check#101

@xtqqczze

xtqqczze commented Dec 5, 2020

Copy link
Copy Markdown
Contributor

Related upstream issue: tcort/markdown-link-check#101

The issue is fixed in tcort/markdown-link-check#106 but there is not yet a markdown-link-check release with these changes (see tcort/markdown-link-check#141) Fixed in v3.8.4.

@xtqqczze

xtqqczze commented Dec 5, 2020

Copy link
Copy Markdown
Contributor

It seems markdown-link-check is making a HTTP GET request for every URL. This is not ideal behaviour for large binaries, to say the least:

PowerShell/README.md

Lines 65 to 112 in ea3036d

[lts-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-x86.msi
[lts-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-x64.msi
[lts-ubuntu18]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.ubuntu.18.04_amd64.deb
[lts-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.ubuntu.16.04_amd64.deb
[lts-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.debian.9_amd64.deb
[lts-debian10]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.debian.10_amd64.deb
[lts-centos]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts-7.0.3-1.rhel.7.x86_64.rpm
[lts-centos8]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts-7.0.3-1.centos.8.x86_64.rpm
[lts-macos]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts-7.0.3-osx-x64.pkg
[rl-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/PowerShell-7.1.0-win-x64.msi
[rl-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/PowerShell-7.1.0-win-x86.msi
[rl-ubuntu20]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell_7.1.0-1.ubuntu.20.04_amd64.deb
[rl-ubuntu18]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell_7.1.0-1.ubuntu.18.04_amd64.deb
[rl-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell_7.1.0-1.ubuntu.16.04_amd64.deb
[rl-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell_7.1.0-1.debian.9_amd64.deb
[rl-debian10]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell_7.1.0-1.debian.10_amd64.deb
[rl-debian11]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell_7.1.0-1.debian.11_amd64.deb
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-1.rhel.7.x86_64.rpm
[rl-centos8]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-1.centos.8.x86_64.rpm
[rl-macos]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-osx-x64.pkg
[rl-winarm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/PowerShell-7.1.0-win-arm64.zip
[rl-winx86-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/PowerShell-7.1.0-win-x86.zip
[rl-winx64-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/PowerShell-7.1.0-win-x64.zip
[rl-macos-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-osx-x64.tar.gz
[rl-linux-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-linux-x64.tar.gz
[rl-arm32]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-linux-arm32.tar.gz
[rl-arm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0/powershell-7.1.0-linux-arm64.tar.gz
[rl-snap]: https://snapcraft.io/powershell
[pv-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/PowerShell-7.2.0-preview.1-win-x64.msi
[pv-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/PowerShell-7.2.0-preview.1-win-x86.msi
[pv-ubuntu20]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview_7.2.0-preview.1-1.ubuntu.20.04_amd64.deb
[pv-ubuntu18]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview_7.2.0-preview.1-1.ubuntu.18.04_amd64.deb
[pv-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview_7.2.0-preview.1-1.ubuntu.16.04_amd64.deb
[pv-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview_7.2.0-preview.1-1.debian.9_amd64.deb
[pv-debian10]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview_7.2.0-preview.1-1.debian.10_amd64.deb
[pv-debian11]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview_7.2.0-preview.1-1.debian.11_amd64.deb
[pv-centos]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview-7.2.0_preview.1-1.rhel.7.x86_64.rpm
[pv-centos8]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-preview-7.2.0_preview.1-1.centos.8.x86_64.rpm
[pv-macos]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-7.2.0-preview.1-osx-x64.pkg
[pv-winarm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/PowerShell-7.2.0-preview.1-win-arm64.zip
[pv-winx86-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/PowerShell-7.2.0-preview.1-win-x86.zip
[pv-winx64-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/PowerShell-7.2.0-preview.1-win-x64.zip
[pv-macos-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-7.2.0-preview.1-osx-x64.tar.gz
[pv-linux-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-7.2.0-preview.1-linux-x64.tar.gz
[pv-arm32]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-7.2.0-preview.1-linux-arm32.tar.gz
[pv-arm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.2.0-preview.1/powershell-7.2.0-preview.1-linux-arm64.tar.gz

@xtqqczze

xtqqczze commented Dec 5, 2020

Copy link
Copy Markdown
Contributor

Reece Dunham (@RDIL) Please update markdown-link-check to v3.8.4.

@xtqqczze

xtqqczze commented Dec 5, 2020

Copy link
Copy Markdown
Contributor

PowerShell-CI-static-analysis still has HTTP error 429 -> Too many requests

@iSazonov

Copy link
Copy Markdown
Collaborator

PowerShell-CI-static-analysis still has HTTP error 429 -> Too many requests

We need update markdown-link-check config or commandline with

retryOn429 if this is true then retry request when response is an HTTP code 429 after the duration indicated by retry-after header.

@xtqqczze

xtqqczze commented Dec 9, 2020

Copy link
Copy Markdown
Contributor

Documentation should be updated as well:

#### Checking links in documentation
Documentation is link-checked. We make use of the
markdown-link-check command line tool,
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 markdown-link-check by
`npm install -g markdown-link-check@3.7.2` (v3.7.2 **only**)
* run `find . \*.md -exec markdown-link-check {} \;`

@iSazonov Ilya (iSazonov) added the CL-Tools Indicates that a PR should be marked as a tools change in the Change Log label Dec 9, 2020
@RDIL

Copy link
Copy Markdown
Contributor Author

PoshChan-Bot (@PoshChan) please rerun linux

@PoshChan

Copy link
Copy Markdown
Collaborator

Reece Dunham (@RDIL), you are not authorized to request a rebuild

@RDIL

Copy link
Copy Markdown
Contributor Author

Fine, I'll do it myself.

Comment thread docs/maintainers/README.md Outdated
Comment thread docs/community/governance.md Outdated
Comment thread test/common/markdown/markdown-link.tests.ps1 Outdated
@xtqqczze

xtqqczze commented Dec 15, 2020

Copy link
Copy Markdown
Contributor

PowerShell-CI-static-analysis (Markdown and Common Tests):

Verify Markdown Links.Verify links in /home/vsts/work/1/s/docs/learning-powershell/powershell-beginners-guide.md.https://www.computerperformance.co.uk/powershell/index.htm should work

Connection timed out

@xtqqczze

xtqqczze commented Dec 15, 2020

Copy link
Copy Markdown
Contributor

PowerShell-CI-static-analysis (Markdown and Common Tests):

Verify Markdown Links.Verify links in /home/vsts/work/1/s/docs/learning-powershell/powershell-beginners-guide.md.https://www.computerperformance.co.uk/powershell/index.htm should work

Connection timed out

Look like a transient failure, but I've submitted #14431 to update the 301 redirect.

Computer Performance
Windows PowerShell Tutorial. An introducton to Microsoft's latest Windows scripting language. Learn PowerShell and master WMI. Replace VBScript and CMD with the PS command line.

@RDIL

Reece Dunham (RDIL) commented Dec 15, 2020

Copy link
Copy Markdown
Contributor Author

PowerShell-CI-static-analysis (Markdown and Common Tests):
Verify Markdown Links.Verify links in /home/vsts/work/1/s/docs/learning-powershell/powershell-beginners-guide.md.https://www.computerperformance.co.uk/powershell/index.htm should work
Connection timed out

Look like a transient failure, but I've submitted #14431 to update the 301 redirect.

Computer Performance**Windows PowerShell Tutorial - Introduction Microsoft's new scripting language**Windows PowerShell Tutorial. An introducton to Microsoft's latest Windows scripting language. Learn PowerShell and master WMI. Replace VBScript and CMD with the PS command line.

I'll rebase once that gets merged.

Computer Performance
Windows PowerShell Tutorial. An introducton to Microsoft's latest Windows scripting language. Learn PowerShell and master WMI. Replace VBScript and CMD with the PS command line.

@RDIL Reece Dunham (RDIL) changed the title Update markdown test tools [On Hold] Update markdown test tools Dec 15, 2020
@xtqqczze

Copy link
Copy Markdown
Contributor

I'll rebase once that gets merged.

Reece Dunham (@RDIL) No need wait for that PR, failures in PowerShell-CI-static-analysis have not persisted.

@ghost ghost added the Review - Needed The PR is being reviewed label Dec 23, 2020
@ghost

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@RDIL Reece Dunham (RDIL) changed the title [On Hold] Update markdown test tools Update markdown test tools Dec 23, 2020
@RDIL

Copy link
Copy Markdown
Contributor Author

Whoops, that wasn't supposed to happen - sorry for anybody that got pinged due to my rebase, it usually doesn't do that!

@iSazonov
Ilya (iSazonov) merged commit 4a09585 into PowerShell:master Jan 12, 2021
@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 12, 2021
@iSazonov Ilya (iSazonov) added this to the 7.2.0-preview.3 milestone Jan 12, 2021
@ghost

Copy link
Copy Markdown

🎉v7.2.0-preview.3 has been released which incorporates this pull request.:tada:

Handy links:

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026
* Update markdown test tools

* Update docs, retry flag

* Fix actual dead links

* Update links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-Tools Indicates that a PR should be marked as a tools change in the Change Log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants