From 0bbb5a33c20d93b618b0ced375f73b3f72d7bd92 Mon Sep 17 00:00:00 2001 From: Andrew Duthie Date: Wed, 14 Oct 2020 09:29:10 -0400 Subject: [PATCH] Add README documentation for visual regression tests --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8448a4b5..844b6ca2 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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. @@ -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: @@ -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.