Skip to content

Add "check-javascript-syntax" CircleCI build task #590

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

Merged
aduth merged 13 commits into from
Mar 19, 2021
Merged

Add "check-javascript-syntax" CircleCI build task #590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bea2aa6
Revert "Include USWDS dependencies in Babel transformations (#587)"
aduth Mar 17, 2021
d2297ed
Add "check-javascript-syntax" CircleCI build task
aduth Mar 17, 2021
286bbe5
Revert "Revert "Include USWDS dependencies in Babel transformations (…
aduth Mar 17, 2021
f6f042c
Try common build for CircleCI jobs
aduth Mar 18, 2021
a7bc1a5
Revert "Include USWDS dependencies in Babel transformations (#587)"
aduth Mar 18, 2021
d18348a
Fix typo
aduth Mar 18, 2021
86141c0
Include build job in workflow
aduth Mar 18, 2021
1e07a35
Include build job in _all_ workflows
aduth Mar 18, 2021
fe78bdf
Re-include checkout, install in per-job
aduth Mar 18, 2021
b6913f9
Checkout first
aduth Mar 18, 2021
0f1661d
Limit workspace attachment to jobs which require full build
aduth Mar 18, 2021
c0fcafb
Use common build for accessibility job
aduth Mar 18, 2021
ff1b80c
Revert "Revert "Include USWDS dependencies in Babel transformations (…
aduth Mar 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 47 additions & 6 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ jobs:
- checkout
- install-dependencies
- build-site
- persist_to_workspace:
root: "."
paths:
- "_site"
Copy link
Copy Markdown
Contributor

@zachmargolis zachmargolis Mar 18, 2021

Choose a reason for hiding this comment

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

do we want to persist the node_modules etc too? or do we assume that caching will take care of that for us

Copy link
Copy Markdown
Contributor Author

@aduth aduth Mar 18, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

do we want to persist the node_modules etc too? or do we assume that caching will take care of that for us

I did that at first, and I found that it took a very long time for the persist_to_workspace step itself to complete, probably because node_modules is a black hole. And yeah, was hopeful that the caching in install-dependencies could keep it fast enough.

See: fe78bdf


test:
docker:
- image: circleci/ruby:2.6-node-browsers
steps:
- checkout
- install-dependencies
- attach_workspace:
at: "."
- run:
name: run tests
command: bundle exec rspec spec
Expand All @@ -54,11 +67,13 @@ jobs:
accessibility:
docker:
- image: circleci/ruby:2.6-node-browsers
environment:
SKIP_BUILD: true
steps:
- checkout
- install-dependencies
# It's not necessary to build the site prior to running end-to-end tests, as it's done as a
# pre-step of the npm test script.
- attach_workspace:
at: "."
- run:
name: run end-to-end tests
command: npm test
Expand All @@ -83,6 +98,18 @@ jobs:
name: check optimized images
command: make lint-assets

check-javascript-syntax:
docker:
- image: circleci/ruby:2.6-node-browsers
steps:
- checkout
- install-dependencies
- attach_workspace:
at: "."
- run:
name: check es5 syntax
command: npm run es5-safe

# Running external links as a separate job so we don't fail the build directly
# but do get the feedback/info
test-external-links:
Expand All @@ -91,7 +118,8 @@ jobs:
steps:
- checkout
- install-dependencies
- build-site
- attach_workspace:
at: "."
- run:
name: Run htmlproofer (external links only)
command: make htmlproofer_external
Expand All @@ -107,11 +135,24 @@ workflows:
- build
- eslint
- check-optimized-assets
- test-external-links
- accessibility
- test:
requires:
- build
- check-javascript-syntax:
requires:
- build
- test-external-links:
requires:
- build
- accessibility:
requires:
- build
daily-external-link-checker:
jobs:
- test-external-links
- build
- test-external-links:
requires:
- build
triggers:
- schedule:
# Once a day at 12pm
Expand Down
18 changes: 8 additions & 10 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"federalist": "npm run build-js",
"watch-js": "webpack -w --config webpack.config.js --progress --color",
"optimize-assets": "svgo --disable=removeViewBox -r -f assets/img",
"es5-safe": "find _site/assets/js/build -name '*.js' -exec cat {} \\; | acorn --ecma5 --silent",
"viewbox": "./node_modules/.bin/svglint 'assets/img/**/*.svg'",
"lint": "eslint spec webpack.config.js assets",
"pretest": "if [ -z $SKIP_BUILD ]; then make build; fi",
Expand All @@ -29,6 +30,7 @@
"keywords": [],
"devDependencies": {
"@axe-core/puppeteer": "^4.1.0",
"acorn": "^8.1.0",
"eslint": "^7.15.0",
"eslint-plugin-prettier": "^3.2.0",
"get-port": "^5.1.1",
Expand Down