NEW Add docs linting step #23
Merged
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
16 tasks
GuySartorelli
force-pushed
the
pulls/1/new-docs-linting
branch
from
a76a667 to
d6c16c5
Compare
emteknetnz
requested changes
Apr 4, 2024
install-nvm.sh
Outdated
| php -r ' | ||
| $hash = "dd4b116a7452fc3bb8c0e410ceac27e19b0ba0f900fe2f91818a95c12e92130fdfb8170fec170b9fb006d316f6386f2b"; | ||
| if (hash_file("sha384", "install.sh") === $hash) { | ||
| echo "Installer verified"; |
There was a problem hiding this comment.
Please don't just say "indentation". If there's a specific problem, please either use the code change suggestion tool to indicate what specific change you want, or use full sentences to tell me what needs to change.
I shouldn't have to re-review my code to see if I can decipher what you mean.
install-nvm.sh
Outdated
| echo "Installer verified"; | ||
| } else { | ||
| echo "Installer corrupt"; | ||
| unlink('install.sh'); |
There was a problem hiding this comment.
Should also add a 'cleanup' thing to remove __install-nvm.sh e.g. https://github.com/silverstripe/gha-trigger-ci/blob/1/action.yml#L95
emteknetnz
requested changes
Apr 4, 2024
action.yml
Outdated
| nvm install $NPM_VERSION && nvm use $NPM_VERSION | ||
| npm install --global yarn | ||
| # Run the linting script | ||
| vendor/bin/ss-docs-lint |
There was a problem hiding this comment.
Suggested change
| vendor/bin/ss-docs-lint | |
| vendor/bin/doclint |
There was a problem hiding this comment.
I don't like this but I'll do it to avoid unnecessary ping pong. We can always change it later if we find a reason to.
GuySartorelli
force-pushed
the
pulls/1/new-docs-linting
branch
from
d6c16c5 to
357b4a5
Compare
emteknetnz
approved these changes
Apr 4, 2024
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.
Description
Adds a new step for linting documentation, provided the matrix tells us to do so.
I've also moved the code for installing
nvminto a separate script file so I can reuse it in the new step. This means if we ever need to update that code, we can just update it in the one place.Issues