通过GitHubActions上传NPM包
简介
GitHub Actions 是一种持续集成和持续交付 (CI/CD) 平台,可用于自动执行生成、测试和部署管道。您可以创建工作流程来构建和测试存储库的每个拉取请求,或将合并的拉取请求部署到生产环境。
GitHub Actions 不仅仅是 DevOps,还允许您在存储库中发生其他事件时运行工作流程。 例如,您可以运行工作流程,以便在有人在您的存储库中创建新问题时自动添加相应的标签。
GitHub 提供 Linux、Windows 和 macOS 虚拟机来运行工作流程,或者您可以在自己的数据中心或云基础架构中托管自己的自托管运行器。
这篇文章主要讲解的是如何使用 GitHub Actions 将仓库中的文件推送到 npmjs 中。
首先,我们先要了解 CI/CD:
Continuous integration:是指开发者经常把代码变化合并到一个中心仓库,然后运行自动化的构建和测试。这样可以尽早地发现和解决集成问题,提高代码的质量。
Continuous delivery:是在 continuous integration 的基础上,把代码变化自动地部署到测试或者生产环境。这样可以实现快速和安全地交付应用程序,而不需要人工干预。Continuous
delivery 的目标是让软件随时可以发布,但是发布的时间由开发者或者业务方决定。
操作
注册 NPM 账号
首先,你应该有一个自己的 npm 网站账号,如何没有,点击这里npm | Sign Up
进行注册。
邮箱验证
完成邮箱验证,注册完成后进入账号管理界面:头像->Account,拉倒最上方,你会看到You have not verified your email address
字样的提示,点击以后按提示步骤验证你的邮箱。
本地NPM用户设置
在本地打开你想要上传的项目[FolderName]
,如何在 github 上就把他 clone 到本地进入文件内打开终端,通过以下命令添加本地 npm
用户设置。
1 | # 仅第一次使用需要添加用户,之后会提示你输入你的npm账号密码以及注册邮箱 |
NPM初始化
运行 npm 初始化指令,按照指示进行配置,注意需要事先确认你的包名没有和别人已发布的包重复,可以在 npm 官网搜索相应包名,搜不到就说明还没被占用。
1 | npm init |
发布到NPM
然后输入发布指令,我们就可以把包发布到 npm 上了。
1 | npm publish |
CDN访问
此时当我们在浏览器访问以下 url 时,将会得到我们想要的静态CDN文件。
1 | # 国外源,中国访问到的是香港节点 |
配置 GitHub Actions
如果每次都要在本地进行npm publish
的话,npm 的提交是整个包一起上传的,不存在增量更新,耗时不说,而且还往往需要架梯子才能正常上传。所以我们可以把它交给
GitHub Actions 来完成。
配置 npm_token
在npm 官网->头像->Access Tokens->Generate New Token,勾选 Automation 选项,Token
只会显示这一次,之后如果忘记了就只能重新生成重新配置了。
添加 NPM_TOKEN环境变量
进入存放我们文件的GItHub仓库,没有的话就创建一个。按如下步骤添加 NPM_TOKEN,把获取的 NPM 的 Access token 输入进去。
添加配置文件
在本地的[FolderName]
文件夹下新建[FolderName]/.github/workflows/publish_config.yml
,写入以下内容:
1 | name: blogAssets-publish |
推送
在本地的[FolderName]
文件夹下打开终端,运行以下指令,上传新增内容至 github,即可触发部署。
1 | # 将更改提交 |
此处的四行指令顺序严格。
每次更新 npm 图床都需要先修改[FolderName]\package.json
里的version
,也就是版本号。
而npm version patch
即为更新 package.json 里的版本号的指令,效果是末尾版本号+1,例如0.0.1=>0.0.2
、1.1.3=>1.1.4
。免去了打开package.json
再修改版本号的麻烦。(大版本更新还是需要手动改的)
更新 npm 图床务必要记得更新package.json
里的版本号!