Github最近添加了一项名为Github Actions的新功能，为我们带来了一套强大的工作流系统，可以处理各种各样的任务。我们在发布Node.js包时可以使用Actions自动运行测试，然后自动将程序包发布到npm上。下面就来看看如何使用Github Actions来为我们的生活带来便利。

目前Github Actions尚处于公开测试阶段，并且仅向注册者开放。你可以点击这里注册并阅读文档。

Github Actions的基本理念是在事件上触发动作。每个Action都是使用YAML文件编写的步骤集合，内容可以非常复杂。本文的示例中我们将创建一个由push事件触发的Action，每当将新的提交推送到存储库时创建一个Action。这个脚本将运行我们的单元测试，然后尝试运行npm publish。

在帐户中启用Actions功能后，你将在每个存储库中找到一个Actions标签。

可用的文档有很多，其中的内容将来可能用得上。不过这里我们就直接开工，先来创建一个工作流。预设工作流列表里有一个是适用Node.js的，点击它后就有了一个起点。

在本教程中，我使用了自己做的一个名为Globfs的包。你可以好好研究一下这个包，更全面地了解我的工作。

我做了很多修改，所以不用管原生提供的Actions脚本预设，看下面就行：

name: Build and test Globfs  
on: [push]  
jobs:
   build:
      runs-on: ubuntu-latest
      strategy:
        matrix:
         node-version: [12.x]
      steps:
      - uses: actions/checkout@v1
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}
      - name: npm install and npm test
        run: |
          npm run setup-test
          npm run test
      - name: npm publish
        run: |
          npm config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN
          npm run trypublish
        env:
          CI: true
          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

当你创建这个脚本时，Github将自动将其添加到你的存储库中，路径为.github/workflows/workflow-name.yml。我这里把它命名为push.yml，因为它处理的是push事件。

探索push.yml Action脚本

这里的name字段只是给出了别人看得懂的名称，因此请随意填写自己喜欢的名字。而on字段要声明将在其上触发的事件，本例中Action在push事件上触发。

事件触发时将执行jobs字段。这里的job是在一个名为ubuntu-latest的Docker容器上运行的，完美适应我们的需求。

下面的steps字段是已执行步骤的列表。第一步actions/checkout@v1只是签出工作区。

顺便提一嘴，Github Actions允许我们复用现有的Actions。本例中我们将复用Github工作区中的action/checkout中定义的Action，你会发现它签出了Git存储库。

下一步将设置Node.js。使用strategy/matrix字段，我们可以设置要在其上运行Action的一系列Node.js版本。本例中我们只想在Node.js 12上运行，因为这是这个包支持的版本。运行actions/setup-node会设置对应的Node.js运行时。

下一步是npm install和npm test，用于测试软件包。为了支持这里的工作，我在顶级package.json中添加了以下脚本：

"scripts": {
     "setup-test": "cd test && npm run setup",
     "test": "cd test && npm run test" 
}

每一步只是进入test目录，并运行那里对应的脚本。在test目录中我加了这个package.json：

{
   "name": "globfs-test",
   "version": "1.0.0",
   "description": "Test suite for globfs",
   "main": "index.js",
   "scripts": {
     "test": "mocha ./index",
     "setup": "npm install && cd .. && npm install"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
     "chai": "^4.1.2",
     "mocha": "^5.2.0"
   }
}

显然test脚本需要index.js中的测试套件。我使用Mocha和Chai断言库创建了一套，你需要的话可以在Globfs存储库中查阅。重要的是让test脚本可靠地执行测试套件，并且如果测试失败，它应该能可靠地显示错误状态。

如果测试失败，则Action脚本也将失败，Github将通过电子邮件将错误日志发送给我们。如果测试脚本成功完成就一切顺利，Action脚本将继续到下一个阶段。

Action脚本的最后一步，即npm publish，就是要发布我们的程序包。从理论上讲这只是运行一下npm publish而已，但是也有一些需要注意的事项。例如，如果你在已经发布的软件包目录上运行npm publish，则npm服务器将抛出一个错误，告诉你无法在现有软件包上发布新包。

我的策略是如果测试成功则始终运行npm publish。如果package.json中的版本字符串已更改，则一切正常，npm publish会顺利将包推送到存储库。如果版本号未更改则将引发错误，任务应该会失败。但是由于我们不在乎npm publish命令是否成功执行，因此可以使用远古时代的一种奇怪的shell脚本技巧来避免失败。

我在顶级package.json中添加了以下脚本：

"scripts": {
     ...
     "trypublish": "npm publish || true"
},

使用trypublish时我们尝试运行npm publish，然后如果失败就使用||true跳过错误。看看这shell脚本技巧多厉害，这可是上世纪70年代流传下来的出色发明。

但仔细看看push.yml中的npm publish阶段，还有一些内容涉及到了npm config命令，这又是什么意思呢？

为了发布到npm，我们需要一个授权令牌。要使它正常工作需要走过一段漫长的旅程，希望我能帮你省一些麻烦。

设置用于身份验证的npm令牌

设置用于身份验证的npm令牌，以从Github Actions流程脚本发布到npm。假设你要在npm publish时进行身份验证，我们只需将npm令牌放在环境变量中一切就能照常运行了。根据npm博客的说法，验证npm的规范方法是将下面这一行添加到~/.npmrc中。

//registry.npmjs.org/:_authToken=00000000-0000 -0000 -0000 -000000000000

但这在上面的Action脚本中很不方便。博客文章说，我们可以这样做：

$ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"

但是我发现没有有效的环境变量。在action/setup-node操作的文档中的这种写法也没用：

- run: npm publish
   env:
     NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

我花了几个小时寻求帮助，期间我发现也有不少人在研究这个问题上浪费了很多时间。但是看过足够多的资料后，我开发了一个可行的解决方案。

让我们一次创建一个步骤，从创建一个npm令牌开始。

登录npmjs.com后，你会在帐户菜单中找到这个选项。这将带你到一个页面，你可以在其中创建（和撤消）令牌。

只需单击创建新令牌（Create New Token）按钮。它会问几个问题，然后带你到显示新令牌的页面。确保将此令牌复制到安全的地方，因为到宇宙终结为止，你只有机会见到它这一次了。

下一步是转到Github存储库的设置（Settings）选项卡，并添加包含你已获得的令牌的密钥。一旦创建完成后，你将永远无法使用Github检查此密钥的内容。

然后在Github Actions脚本中，我们用以下方式访问此密钥，将其添加到环境中：

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

但这还不够，和有关身份验证令牌的npm文档说的不一样。无论我使用什么环境变量，npm publish都无法识别该令牌。只有添加下面这行命令后它才起作用：

npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN

这个配置必须同样添加到.npmrc文件中。该命令在Github处理该作业的Docker容器中运行。

完成此操作后，npm publish命令将按预期正常工作。

小结

Github Actions还在发展初期。Github Actions的宣传很美好，但是实际的工作做起来要麻烦的多。其实有些磕磕绊绊是可以改进的，这样能省掉很多麻烦。

这种自动化流程能帮助开发人员优雅地工作。要是测试Node.js程序包并将其发布到npm存储库的过程都没法自动，你的生活得有多悲催。你需要针对每个发行版在终端中键入所需的命令。如果你忘记了命令或忘了参数怎么办？如果你忘记发布新版本该怎么办？可能会发生各种各样的错误。自动化所有这些流程无疑要可靠得多，这样你就可以重复执行流程了。

可以肯定的是——过去，Gitlab在这一方面一直比Github占优。因为Gitlab长期以来一直拥有CI/CD子系统。使用该系统，你可以将一个YAML文件添加到描述CI/CD工作流程的存储库中，然后就获得了自动化便利。如今Github Actions功能更加灵活，Gitlab需要好好赶上来了。

原文链接：
https://itnext.io/simplify-your-npm-publish-workflow-using-github-actions-691249bc7e59

创作场景

玩转 GitHub Actions，简化 npm 发布流程