reg-simple-keygen-plugin

Determine snapshot key with given values

Usage no npm install needed!

<script type="module">
  import regSimpleKeygenPlugin from 'https://cdn.skypack.dev/reg-simple-keygen-plugin';
</script>

README

reg-simple-keygen-plugin

A reg-suit plugin to determine the snapshot key with given values.

Install

npm i reg-simple-keygen-plugin -D

Configure

{
  expectedKey: string;
  actualKey: string;
}
  • expectedKey - Required - Identifier key value of the expected(previous) snapshot.
  • actualKey - Required - Identifier key value of the actual(current) snapshot.

Example

Using environment values

Using reg-suit's replacing environment values feature, you can use Git commit sha1 hashes provided with CI service. The following example allows reg-suit to compare HEAD of the master branch with the PR's commit.

# .travis.yml
script:
  - export EXPECTED_KEY=$(git rev-parse origin/master)
  - export ACTUAL_KEY=$TRAVIS_COMMIT # set by TravisCI
  - reg-suit run

  // regconfig.json
  "plugins": {
    "reg-simple-keygen-plugin": {
      "expectedKey": "${EXPECTED_KEY}",
      "actualKey": "${ACTUAL_KEY}"
    },
    ...
  }