actions-yarn/README.md

GitHub Actions for Yarn

Look https://github.com/actions/npm for more details.

This Action for yarn enables arbitrary actions with the yarn command-line client, including testing packages and publishing to a registry.

Usage

An example workflow how to install packages via Yarn (using repository syntax):

name: CI
on: [push]
jobs:
  build:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: borales/actions-yarn@v2.0.0
        with:
          cmd: install
      - uses: borales/actions-yarn@v2.0.0
        with:
          cmd: build
      - uses: borales/actions-yarn@v2.0.0
        with:
          cmd: test

cmd value will be used as a command for Yarn

Secrets

• NPM_AUTH_TOKEN - Optional. The token to use for authentication with the npm registry. Required for yarn publish (more info)

Environment variables

• NPM_REGISTRY_URL - Optional. To specify a registry to authenticate with. Defaults to registry.npmjs.org
• NPM_CONFIG_USERCONFIG - Optional. To specify a non-default per-user configuration file. Defaults to $HOME/.npmrc (more info)

Example

To authenticate with, and publish to, a registry other than registry.npmjs.org:

- uses: borales/actions-yarn@v2.0.0
  with:
    auth-token: ${{ secrets.NPM_TOKEN }}
    registry-url: someOtherRegistry.someDomain.net