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.

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

Linting workflow for CI #12

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

benwarfield-usds
Copy link

@benwarfield-usds benwarfield-usds commented Oct 8, 2020

Added

  • sass-lint (with configuration)
  • htmllint (with configuration)
  • a workflow file for Github Actions that runs those two things and jekyll hyde on every pull request
  • a manually-triggered workflow for Actions that builds the site and uploads the result.

Fixed

  • all the lint errors that this exposed

Added scripts to lint HTML and SCSS (or both!) and to run jekyll "hyde" (hah) checks.
The "hyde" command is not included in the overall "lint" because it we will want to run
javascript-only checks more often and possibly in ruby-free environments.
This value obviously only works for local builds, but it *does* work for
those, and for CI checks, so it seems better to have than not.
Added a workflow to run lint checks on all pull requests, and tweaked
the package scripts to allow skipping Ruby gem installation when no
jekyll execution is planned.
@benwarfield-usds
Copy link
Author

See benwarfield-usds#1 to see the workflow actually working.

@@ -26,8 +30,11 @@
"gulp-replace": "^1.0.0",
"gulp-sass": "^4.1.0",
"gulp-sourcemaps": "^2.6.5",
"htmllint-cli": "0.0.7",
"markdownlint-cli": "^0.24.0",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't actually use this because the base distro has no markdown in it. Probably worth fixing that, and then adding some linting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant