Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
package

GitHub Action

GitHub Action for Yarn

v2.3.0

GitHub Action for Yarn

package

GitHub Action for Yarn

Wraps the yarn CLI to enable common yarn commands

Installation

Copy and paste the following snippet into your .yml file.

              
- name: GitHub Action for Yarn

              
  uses: Borales/[email protected]
Learn more about this action in Borales/actions-yarn

Choose a version

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.

Please keep in mind that this Action was originally written for GitHub Actions beta (when Docker was the only way of doing things). Consider using actions/setup-node to work with Yarn. This repository will be mostly supporting the existing flows.

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/[email protected]
        with:
          cmd: install # will run `yarn install` command
      - uses: borales/[email protected]
        with:
          cmd: build # will run `yarn build` command
      - uses: borales/[email protected]
        with:
          cmd: test # will run `yarn test` command

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/[email protected]
  with:
    auth-token: ${{ secrets.NPM_TOKEN }}
    registry-url: someOtherRegistry.someDomain.net