Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better detect unformatted markdown files #422

Merged
merged 5 commits into from
Oct 23, 2023
Merged

Better detect unformatted markdown files #422

merged 5 commits into from
Oct 23, 2023

Conversation

ian-noaa
Copy link
Collaborator

@ian-noaa ian-noaa commented Oct 23, 2023 •
edited
Loading

This change splits the lint NPM run script into its component parts and then calls then with run-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

@ian-noaa
Separate out the NPM linter scripts
ba3fefd 
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.
@ian-noaa
Update CI to lint documentation in a separate job
c2405f7 
We don't want unlinted docs to fail our application deployments.
However, we do still want the docs to be checked for formatting issues.
@ian-noaa
Add Markdown to our precommit checks
2dabfc7
@ian-noaa ian-noaa self-assigned this Oct 23, 2023
@ian-noaa ian-noaa linked an issue Oct 23, 2023 that may be closed by this pull request
Unformatted Markdown files block deploys #420
Closed
@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 18:42 — with GitHub Actions Inactive
@ian-noaa
Update CONTRIBUTING with linter scripts
0e835e7 
Mostly I wanted to trigger a run of the new "docs" CI pipeline.
@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 18:46 — with GitHub Actions Inactive
@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 18:49 — with GitHub Actions Inactive
@ian-noaa
Install prettier directly
8cc8abf 
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.
@github-actions
Copy link

Code Coverage

Package Line Rate Branch Rate Health
unified_graphics 84% 72% ✔
unified_graphics.etl 97% 96% ✔
utils.s3 68% 69% ➖
Summary 86% (412 / 479) 82% (98 / 120) ✔

Minimum allowed line rate is 60%

@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 21:18 — with GitHub Actions Inactive
@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 21:23 — with GitHub Actions Inactive
@ian-noaa ian-noaa merged commit 0d46dab into main Oct 23, 2023
14 checks passed
@ian-noaa ian-noaa deleted the 420-unformatted-markdown-files-block-deploys branch October 23, 2023 21:33
@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 21:33 — with GitHub Actions Inactive
@ian-noaa ian-noaa temporarily deployed to vlab October 23, 2023 21:33 — with GitHub Actions Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@esheehan-gsl esheehan-gsl esheehan-gsl approved these changes

Assignees

@ian-noaa ian-noaa

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Unformatted Markdown files block deploys
2 participants
@ian-noaa @esheehan-gsl