This repository has been archived by the owner on Sep 30, 2024. It is now read-only.
Better detect unformatted markdown files #422
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
We want more control over which linters we run, when, so that we can separate out CI jobs for linting our JS code and our Markdown docs. While we're at it, remove the deprecated Prettier "--plugin-search-dir" flag.
We don't want unlinted docs to fail our application deployments. However, we do still want the docs to be checked for formatting issues.
Mostly I wanted to trigger a run of the new "docs" CI pipeline.
This removes a dependency on our project NPM setup for this CI job. Configuring NPM and installing our dependencies currently takes over half this CI job runs for so it'll be interesting to see if this speeds that up any.
Minimum allowed line rate is |
esheehan-gsl
approved these changes
Oct 23, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This change splits the
lintNPM run script into its component parts and then calls then withrun-p. It also adds a CI job to explicitly check our documentation for formatting errors. This will better detect unformatted Markdown files and no longer block application deployments if unformatted Markdown slips into the codebase.Closes #420