GitHub Actions for Yarn 使用教程

GitHub Actions for Yarn 使用教程

actions-yarnGitHub Action for interacting with yarn项目地址:https://gitcode.com/gh_mirrors/ac/actions-yarn

1. 项目介绍

actions-yarn 是一个 GitHub Action，旨在通过 Yarn 命令行客户端执行任意操作。它允许用户在 GitHub Actions 工作流中使用 Yarn 来安装、测试、构建和发布包。该项目由第三方提供，并遵循单独的服务条款、隐私政策和支持文档。

2. 项目快速启动

2.1 安装依赖

首先，确保在 GitHub Actions 工作流中设置 Node.js 版本。然后使用 actions-yarn 安装依赖包。

name: CI
on: [push]
jobs:
  build:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set Node.js 16.x
        uses: actions/setup-node@v3
        with:
          node-version: '16.x'
      - name: Run install
        uses: borales/actions-yarn@v4
        with:
          cmd: install

2.2 运行测试

在安装依赖后，可以使用 actions-yarn 运行测试。

- name: Run test
  uses: borales/actions-yarn@v4
  with:
    cmd: test

2.3 构建生产包

最后，使用 actions-yarn 构建生产包。

- name: Build production bundle
  uses: borales/actions-yarn@v4
  with:
    cmd: build:prod

3. 应用案例和最佳实践

3.1 在子文件夹中运行测试

如果项目包含多个子文件夹，可以在特定子文件夹中运行测试。

- name: Run test in sub-folder
  uses: borales/actions-yarn@v4
  with:
    cmd: test
    dir: 'frontend'

3.2 使用私有注册表

如果需要使用私有注册表，可以在环境变量中设置 NODE_AUTH_TOKEN。

env:
  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

4. 典型生态项目

4.1 actions/setup-node

在使用 actions-yarn 之前，通常需要使用 actions/setup-node 来设置 Node.js 版本。

- name: Set Node.js 16.x
  uses: actions/setup-node@v3
  with:
    node-version: '16.x'

4.2 actions/checkout

在运行任何操作之前，通常需要使用 actions/checkout 来检出代码库。

- uses: actions/checkout@v3

通过以上步骤，您可以快速上手并使用 actions-yarn 在 GitHub Actions 中自动化 Yarn 操作。

actions-yarnGitHub Action for interacting with yarn项目地址:https://gitcode.com/gh_mirrors/ac/actions-yarn