circleci-update-yarn-lock

Shell script to update your yarn lock file after greenkeeper pulls

Usage no npm install needed!

<script type="module">
  import circleciUpdateYarnLock from 'https://cdn.skypack.dev/circleci-update-yarn-lock';
</script>

README

CircleCI update yarn.lock

Script to update your yarn.lock file from CircleCI, run this after every greenkeeper PR.

Usage

Use this script to update your yarn.lock file whenever greenkeeper reminds you to update.

Install

You need to add this module to your package.json.

yarn add --dev circleci-update-yarn-lock

Then add this to your package.json scripts. The following script setup will work for the configure step next.

"scripts": {
  "update-yarn-lock-file": "update-yarn-lock-file"
},

Configure

Add the following to your circle.yml file to watch for greenkeeper branches and run this script when it sees them.

deployment:
  greenkeeper:
    branch: /greenkeeper\/.*/
    commands:
      - yarn run update-yarn-lock-file

SSH Key for Write Access

In order to deploy from your CI to your repository you need to give CircleCI write access via an SSH key.

Follow the CircleCI instructions for adding read/write deployment key.

Once you'd added the key you should see your builds working.

Development

Requirements

brew install yarn

Clone Repository

git clone --recurse-submodules git@github.com:clarkbw/circleci-update-yarn-lock.git
cd circleci-update-yarn-lock

Tests

Requirements

brew install bats
  • git submodules. We use some nicer scripts with bats and this requires some additional modules
git submodule sync
git submodule update --init

Running Tests

yarn test