Skip to content

chore: add porcelain check to the build #53

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
junglebarry merged 2 commits into from
Jun 26, 2025
Merged

chore: add porcelain check to the build #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aba5ce4
chore: add porcelain check to the build
junglebarry Jun 26, 2025
e595756
chore: document the requirement to check in generated files
junglebarry Jun 26, 2025
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
3 changes: 3 additions & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ npm start

Open <http://localhost:8080> 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`.
Expand Down