diff --git a/.circleci/config.yml b/.circleci/config.yml index 898d29d..aaecd54 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -70,6 +70,9 @@ jobs: - run: name: "Build" command: npm run build + - run: + name: Report uncommitted changes produced by the build, failing if any exist + command: UNCOMMITTED=$(git status --untracked-files=no --porcelain) && echo "$UNCOMMITTED" && [ -z "$UNCOMMITTED" ] push_to_github_pages: <<: *executor_node steps: diff --git a/README.md b/README.md index 52ff49a..494ec60 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,14 @@ npm start Open to see the page in action. +## Building + +We have an automated build that runs quality checks. However, the GitHub Pages site relies on having all generated files checked in to source control. Therefore, if you're making changes on a branch, the final step will always be to run the following in a final commit to ensure the generated files are all checked in: + +```bash +npm run build +``` + ## Scripts The following npm scripts are available. With the exception of `npm start` and `npm test`, the remaining scripts can be run from your command line with `npm run scriptName`.