npm

如何使用 GitHub Action 自动发布 NPM

black and white penguin toy
~ 白宦成 ~ 2 Comments

我经常会用 GitHub 来存储我的代码，其中很大一类是各种 npm 包。

由于本地常年配置了 npm 的 mirror，我更喜欢使用 GitHub 自动发布。

有了这个配置，我只需要编写完代码后，并执行如下命令，即可实现自动发布包.

npm version patch
git push --all
git push --tags

以下是对应的 GitHub action file。

使用时需要配置 npm_token 为你自己的 NPM Token。这个 Token 可以在 NPM 后台获取到。

name: Node.js Package
on:
  push:
    tags:
    - "*"
jobs:
  publish-npm:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: 14
          registry-url: https://registry.npmjs.org/
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
Code language: JavaScript (javascript)

发布 NPM 包时，遭遇 You should bug the author to publish it (or use the name yourself!) 怎么办?

orange pink keyboard
~ 白宦成 ~ Leave a comment

在发布一个 NPM 包时，我遭遇了这样的一个问题：

You should bug the author to publish it (or use the name yourself!)
Code language: PHP (php)

经过查询后发现，是因为我之前使用的 Login Token 失效了，在这种情况下，只需要重新执行npm adduser添加用户，即可解决问题。

我之前以为是 login 没用，要 adduser 才能使用，后来查询了一下 npm 的文档发现 login 是 adduser 的一个别名，二者功能是一样的，因此，不存在 login 的权限不如 adduser 的问题。

如何控制发布到 NPM 中的文件？

orange pink keyboard
~ 白宦成 ~ Leave a comment

如果你使用 Typescript 编写 npm 包，可能会发现自己编写的 ts 文件也被发布到了 NPM 上去。

一般来说，这个其实并没有什么，除非你的包并不开源，又或者你有精神洁癖，希望用户看到的包的文件目录是足够简单明了的。

这个时候，你可以借助 npm 中的 files 这个字段，来控制你需要上传的文件。

比如,如果你按照下面的方式配置 files 就可以控制你的包在发布时，只发布有限的文件，比如必须的 package.json、LICENSE、README 以及构建产物 dist 文件夹。

{
   "name":"your-package",
   "files":[
     "package.json",
     "README.md",
     "LICENSE",
     "dist"
   ]
}
Code language: JSON / JSON with Comments (json)