test(common): add markdown link check test for product documentation #12472
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds check-markdown package that parses .md files, looks for links and images, and verifies that they are valid links (for internal links).
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
github-actions
bot
added
windows/
android/
developer/
ios/
mac/
linux/
common/
common/resources/
Base automatically changed from
refactor/developer/12347-move-help-in-repo
to
master
September 28, 2024 02:34
mcdurdin
commented
Oct 7, 2024
ios/build.sh
Outdated
Comment on lines
12
to
13
| # Please note that this build script (understandably) assumes that it is running on Mac OS X. | ||
| verify_on_mac | ||
| # verify_on_mac |
There was a problem hiding this comment.
I'm not convinced we need this. Build will fail if we try on a non-Mac anyway. And by leaving it off, we can do things like run test:help
mac/build.sh
Outdated
Comment on lines
28
to
29
| # Please note that this build script (understandably) assumes that it is running on Mac OS X. | ||
| verify_on_mac | ||
| # verify_on_mac |
There was a problem hiding this comment.
I'm not convinced we need this. Build will fail if we try on a non-Mac anyway. And by leaving it off, we can do things like run test:help
| @@ -301,3 +301,7 @@ _select_node_version_with_nvm() { | |||
| builder_die "Attempted to select node.js version $REQUIRED_NODE_VERSION but found $CURRENT_NODE_VERSION instead" | |||
| fi | |||
| } | |||
|
|
|||
| check-markdown() { | |||
| node "$KEYMAN_ROOT/resources/tools/check-markdown" --root "$1" | |||
There was a problem hiding this comment.
We rely on build.sh building things as needed, but we could check for existence of build/index.js and build it here if missing also
mcdurdin
requested review from
rc-swag,
ermshiperete,
jahorton,
sgschantz,
SabineSIL and
darcywong00
as code owners
ermshiperete
reviewed
Oct 7, 2024
darcywong00
reviewed
Oct 8, 2024
ermshiperete
approved these changes
Oct 10, 2024
|
Changes in this pull request will be available for download in Keyman version 18.0.126-alpha |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds check-markdown package that parses .md files, looks for links and
images, and verifies that they are valid links (for internal links).
@keymanapp-test-bot skip