Skip to content

Commit

Permalink
Add README documentation for visual regression tests
Browse files Browse the repository at this point in the history
  • Loading branch information
aduth committed Oct 14, 2020
1 parent 3b90a27 commit 0bbb5a3
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ npm start
npm run lint
```

## Visual regression tests

When a pull request is submitted, a visual regression test will be automatically run to check for any visual changes between the working copy of the branch and the live documentation site. These will be reported as the `ci/circleci: visual-regression` GitHub status check.

A failure of this status check only indicates that a visual change was detected. Depending on the types of changes being proposed, this may be expected. Anyone with access to the CircleCI dashboard can review the specific changes by following the status check "Details" link and comparing the set of screenshots under the "Artifacts" tab. If the visual changes are acceptable, the pull request can be merged, even if the status check is reported as a failure.

## Deploying documentation updates

Documentation deploys are performed automatically upon merging to `master` by [Federalist](https://federalist.18f.gov/). Federalist performs the following steps:
Expand All @@ -44,7 +50,7 @@ More information can be found in Federalist’s [How Builds Work](https://federa

## Publishing a release to `npm`

When you're ready to release a new version of the `identity-style-guide` package there are just a few steps to take.
When you're ready to release a new version of the `identity-style-guide` package there are just a few steps to take.

1️⃣ Make sure all the changes indended for release are merged into the `master` branch.

Expand All @@ -54,7 +60,7 @@ When you're ready to release a new version of the `identity-style-guide` package

`npm version patch -m "Upgrade to %s for reasons"`

And a new version will be created.
And a new version will be created.

4️⃣ Once you’re satisfied with any updates, do a trial publish to `npm` by running:

Expand All @@ -70,4 +76,4 @@ No need to run any special build steps — the publish script will lint the sour
npm publish
```

6️⃣ Document the release on Github. After you've pushed the release changes back up to `master`, [create a new release](https://github.com/18F/identity-style-guide/releases) with a target of `master`. The release version should match the version you just sent off to `npm` (like `v2.1.5`) and the title can be the same. Use the release notes to link to any important issues or pull requests that were addressed in the release.
6️⃣ Document the release on Github. After you've pushed the release changes back up to `master`, [create a new release](https://github.com/18F/identity-style-guide/releases) with a target of `master`. The release version should match the version you just sent off to `npm` (like `v2.1.5`) and the title can be the same. Use the release notes to link to any important issues or pull requests that were addressed in the release.

0 comments on commit 0bbb5a3

Please sign in to comment.