0

0

VShell:生产发布工作流程

心靈之曲

心靈之曲

发布时间:2024-11-20 09:01:18

|

599人浏览过

|

来源于dev.to

转载

本周,我准备将我的命令行工具 vshell 发布到生产环境。此版本将使用户能够直接通过 npm 安装和使用 vshell,而无需在本地克隆和构建项目。该工具使用 javascript 和 node.js 编写,将托管在 npm 上以便于分发。以下是我实现此版本所遵循的步骤的详细分解:

自动化构建过程

为了确保可重复和自动化的构建,我在项目的根目录中创建了一个 build.js 脚本。该脚本将所有必需的文件复制到 dist 文件夹中,从而简化了构建过程。

VShell:生产发布工作流程

此外,我还在package.json中设置了一个脚本来运行它:

"build": "node build.js"

要运行它,只需在控制台输入:npm run build

目前,我只是想演示一个简单的构建作为复制文件,但将来,如果我用 ui 实现,那么我需要使用模板捆绑脚本作为 barbel。

实施语义版本控制

以前,我经常在更改后忘记更新项目版本。在此版本中,我采用了语义版本控制来清楚地传达项目 api 中的更改。

考虑到 v0.0.1 以来的重大更新,我通过更新 package.json 中的版本字段将版本设置为 v1.0.0。此版本反映了稳定的 api,具有重大更改和新功能。

git 中标记发布

为了与 github 发布同步版本更新,我为 v1.0.0 创建了一个 git 标签:

git tag -a v1.0.0 -m "release version 1.0.0"
git push origin --tags

这可确保在 git 存储库中正确跟踪发布。

声明包文件

为了将 vshell 发布为 npm 包,我使用 package.json 中的 files 字段明确定义了要包含在包中的文件。这可确保发布的包中仅包含必要的文件和目录。

示例:

VShell:生产发布工作流程

发布到 npm

在 npm 上发布 vshell:

  • 注册并登录:我创建了一个 npm 帐户并使用以下方式登录: 登录
  • 发布:经过身份验证后,我发布了包: npm 发布

这使得用户可以通过 npm 使用 vshell。

酷源OA系统 2008奥运版
酷源OA系统 2008奥运版

........酷源科技旗下产品DoeipOA 2008奥运版,经过精心策划、周密准备和紧密的团队协作,于近日正式推出,功能齐全,操作更加人性化,是公司适应市场发展的需求,以用户为导向努力打造的新一代OA产品。采用了.net平台先进的开发技术,酷源OA办公自动化系统拥有信息交流、工作日志、日程安排、网络硬盘、在线QQ交流等超过三十大项基本功能及上百种子功能模块,包括体验版、标准版、企业版、集团版、

下载

超出范围的更新

github dependabot 标记了传递依赖交叉生成的安全问题。由于我没有直接安装,所以我使用了:

npm ls 交叉生成

识别哪个包依赖于它。我发现 eslint 是源头,并通过将 eslint 更新到最新版本解决了该问题。

此外,我更新了 readme.md 以为 npm 用户提供清晰的安装说明。我还改进了 contributing.md 文件,以指导贡献者在本地设置和运行 vshell。

为了提高准确性,我吸收了 david humphrey 教授的反馈,扩展并澄清了 groq 系统文档。

使用 github actions 自动发布

为了简化发布流程,我在 github actions 工作流程中添加了一项作业,以便在推送新标签时自动执行 npm 发布。

工作流程添加:

release:
    needs: build

    runs-on: ubuntu-latest

    if: startsWith(github.ref, 'refs/tags/')

    permissions:
      contents: write

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Setup Node.js
      uses: actions/setup-node@v4
      with:
        node-version: 22.x
        registry-url: 'https://registry.npmjs.org'

    - name: Install dependencies
      run: npm ci

    - name: Build project
      run: npm run build

    - name: Update version
      run: npm version ${{ github.ref_name}} --no-git-tag-version

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

    - name: Create GitHub release
      uses: softprops/action-gh-release@v1
      with:
        name: Release ${{ github.ref_name}}
        draft: false
        prerelease: false
        token: ${{ secrets.GITHUB_TOKEN }}

主要特点:

条件触发:只有当标签(v*.*.*)被推送时才会触发发布作业。

npm 身份验证:使用存储在 github secrets 中的安全 npm_auth_token。您可以通过转到您的 npm 帐户并选择“访问令牌”部分来创建此令牌。

github release:使用 softprops/action-gh-release 自动生成版本。

结论

按照这些步骤,我成功地将 vshell 自动化发布到 npm。用户现在可以通过以下方式轻松安装和使用该工具:

npm install -g vshell

这种简化的流程,加上适当的版本控制、依赖关系管理和文档更新,确保了 vshell 的专业且用户友好的发布。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

420

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

536

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

312

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

515

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

245

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

320

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5331

2023.08.17

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

30

2026.01.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 3.1万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号