在gitlab上发布npm二进制文件

允许奇迹发生

大家好,我是「柒八九」。一个「专注于前端开发技术/RustAI应用知识分享」Coder

前言

还记得之前我们讲过如何在 npm 上发布二进制文件?吗。我们通过npm将我们之前在Rust 赋能前端-开发一款属于你的前端脚手架中生成Rust二进制文件发布到npm仓库中。

如果想体验上述功能,可以通过npm全局安装f_cli_f[1]在本地体验一下。

如果,你不想把自己的npm发布到公网上,那么我们还可以将我们的npm发布到公司内网上。这个我们在如何在gitlab上发布npm包介绍过了。

但是呢,在如何在gitlab上发布npm包中我们只是介绍了如何发布一个正常的npm,并且还不涉及各个包直接的关联。如果,我们想在gitlab发布二进制类型的包,同时还涉及多个包直接的交互呢,上面的方案就有点捉襟见肘了。

那么,我们今天就聊聊,如何在「gitlab发布npm二进制包」并且我们还会涉及npm包直接的互相操作。

好了,天不早了,干点正事哇。

alt

我们能所学到的知识点

  1. 项目结构
  2. 发布子包到gitlab 仓库
  3. 主包逻辑
  4. 全局安装并执行

1. 项目结构

我们采用和之前发布到npm的目录结构几乎一样。

alt

有四个包

  1. f_cli_windows_x64: f_cli 适配 Windows架构
  2. f_cli_darwin_x64: f_cli 适配 MACOS_Intel64架构
  3. f_cli_darwin_arm64: f_cli适配 MACOS_ARM64架构
  4. f_cli:主包,用户根据用户操作环境下载对应的二进制文件

2. 发布子包到 gitlab 仓库

子包有3个,分别针对我们常见的开发环境。其实它们的内容极其简单。这个和之前在如何在 npm 上发布二进制文件?中是一样的。

"f_cli_darwin_arm64"/"f_cli_darwin_x64"
 ├── package.json
 └── bin/
     └── f_cli

"f_cli_windows_x64"
 ├── package.json
 └── bin/
     └── f_cli.exe

bin文件中存放的就是我们脚手架编译后的二进制文件。

由于这三个子包的处理方式都出奇的一致。我们就随意挑选一个来讲解

创建.npmrc

在如何在gitlab上发布npm包讲过,如果要在gitlab发布npm私包,我们需要创建一个.npmrc

@<your-scoop>:registry=https://公司gitlab域名/api/v4/npm/
//公司gitlab域名/api/v4/projects/<your_project_id>/packages/npm/:_authToken=${AUTH_TOKEN}`

当然,我们还需要在gitlab中构建一个空项目,这步就省略了。

上面有几个参数我们需要变更

  1. <your-scoop>:这里设置我们的想要的名称,这里我们设置为 cli
  2. <your_project_id>:这是我们 demo项目在 gitlab的id,这个我们可以在 Settings->General->Project ID获取
    • alt
  3. AUTH_TOKEN我们使用环境变量来处理,这个变量在主页面的 Settings->Repository->Deploy tokens中设置 token
    • alt

别忘记,在生成token时,将值保存起来。

修改package.json

我们在package.json中还需要新增publishConfig,这是用于npm publish时用的。

{
  //...
  "publishConfig": {
    "@cli:registry""https://公司gitlab域名/api/v4/projects/project_ID/packages/npm/"
  }
}

发布包

最后,我们使用

AUTH_TOKEN=XXX npm publish

将本地的二进制包发布到了gitlab。可以看出,我们使用的手动发布的方式。是因为,我们这三个子包其实内部没啥逻辑,只是一个二进制文件,所以我们就选择了用「手动发布」的方式。

随后,我们就可以在demo项目中的Deploy->Package Registry中看到发布成功的包

alt

3. 主包逻辑

下面到了我们这篇文章的核心部分。

其实,主包的目录结构也很简单。

alt

新增.npmrc

还是一样的套路。

@<your-scoop>:registry=https://公司gitlab域名/api/v4/npm/
//公司gitlab域名/api/v4/projects/<your_project_id>/packages/npm/:_authToken=${AUTH_TOKEN}`

只不过需要将上面的信息,置换成主包的相关内容。

修改package.json

由于是主包,我们就需要额外的操作,这里就两点需要新增

  1. bin
  2. publishConfig
{
  "bin": {
    "front_cli""bin/cli"
  },
  "publishConfig": {
    "@cli:registry""https://gitlab.com/api/v4/projects/project_ID/packages/npm/"
  },
}

publishConfig就不用多说了,就是给npm发布用的。而bin中指定的信息就是,当此软件包「全局安装」时,该文件将链接到全局 bins 目录内,或者将创建一个 cmdWindows 命令文件)来执行 bin 字段中的指定文件,因此可用于由 namename.cmd(在 Windows PowerShell 上)运行。更过的可以参考package.json_bin[2]

当然,如果我们使用像nvm/fnmnode版本管理工具的话,也会在指定的地方进行配置。最终的结果就是,可以使得我们的包能够在全局访问并且执行对应的命令。

由于,我们本机使用的是fnm,然后在主包被全局安装后,在对应的node文件夹中就会新增对应的信息。

alt

bin/cli

这个和之前我们讲如何在 npm 上发布二进制文件?不同。

我们之前在package.json中还有

{
  "scripts": {
    "postinstall""node ./install.js"
  },
}

也就是在包被安装后,会自动触发postinstall命令,执行node ./install.js。里面就是根据各种平台信息和对应包的下载。

下面是之前install.js的主要逻辑。 alt

但是呢,我们从本地安装发布到gitlab的私包时,它不触发postinstall的命令,也就是在主包下载后,无法下载对应的子包。那意味着我们的这个功能直接垮掉。

所以,我们索性取消掉postinstall的逻辑,将下载和执行二进制的路径都迁入到bin/cli中。

alt

对比之前的install.js的逻辑,粗看下,其实没啥变化。主要流程还是根据process.platformprocess.arch确定平台和架构,然后从BINARY_DISTRIBUTION_PACKAGES查找对应的信息。

BINARY_DISTRIBUTION_PACKAGES

由于我们发布的位置和名称也发生变化。这里的BINARY_DISTRIBUTION_PACKAGES也有些许变更。

const BINARY_DISTRIBUTION_PACKAGES = {
  'darwin-x64''@cli/x64',
  'darwin-arm64''@cli/arm64',
  'win32-x64''@cli/windows_x64',
}

其实还有几点也发生了变化。之前我们是从npm中下载二进制包。由于我们在npm发布的公共包,也就意味着所有人都可以通过ajax进行获取。但是呢,我们现在也想通过ajaxnode项目中获取gitlab私包。这就需要提供额外的信息。

  1. projectID
  2. 授权信息

projectID被存放在了PROJECT_ID_MAP中。

const PROJECT_ID_MAP = {
  'darwin-x64''1',
  'darwin-arm64''2',
  'win32-x64''3',
}

然后,授权就是我们在进行异步接口时候,需要通过headerAuthorization字段提供。而这个字段的值就是之前我们申请的Deploy token(是不是让你保存了)。

我们之前提过,由于postinstall命令不好使,我们就把之前的install.jsbin/cli的逻辑合二为一了。

那就意味着现在bin/cli在被执行时,下载对应平台的二进制文件,并且根据参数执行命令。

downloadBinaryFromGitlab

alt

这里我们分了两种情况

  1. 首次全局安装,那就需要下载对应的二进制文件并执行
  2. 非首次安装,那就直接执行对应的二进制文件就行。

剩余的逻辑和之前是一样的。

makeRequest

这里也是一个重点。

alt

这里和之前的方法也有几点不同。

  1. 新增了 token参数
  2. https新增了 options
  3. 根据数据返回的多少,显示了下载进度信息

先看makeRequest如何被调用。

const tarballDownloadBuffer = await makeRequest(
    `https://公司gitlab域名/api/v4/projects/${projectID}/packages/npm/${platformSpecificPackageName}/-/${platformSpecificPackageName}-${BINARY_DISTRIBUTION_VERSION}.tgz`,
    "glpat-xxx"
  )

我们来简单解释一下,由于我们现在是从gitlab拉取私库,都说了是私库,那势必就有鉴权处理。 这里的token就是接收之前的Deploy Token

然后,将接收到的token放到httpsoptionsheaders中。

针对这点,我们可以从gitlab官网[3]查看。

针对进度信息的展示,也是很简单的逻辑,就是基于responsedata事件,每次跟新downloaded,并且用process.stdout.write输出到控制台。

发布主包

虽然,主包看起来逻辑比较多,但是在发布时,也是一句话搞定

AUTH_TOKEN=XXX npm publish

随后,我们就可以在gitlab中看到发布的包信息了。


4. 全局安装并执行

既然,我们已经将主包发布到了gitlab,那我们就需要使用其他方式将其下载到本地,然后执行对应的命令。

修改全局.npmrc

之前的文章讲过,如果想要下载gitlab的私包,那就需要修改本地.npmrc和全局.npmrc

因为,我们要全局安装,所以我们直接修改全局.npmrc

使用open ./.npmrc打开.npmrc并加入如下命令

@cli:registry=https://公司gitlab域名/api/v4/projects/projectId/packages/npm
//公司gitlab域名/api/v4/projects/projectId/packages/npm/:_authToken=glpat-xxxx

大家根据自己的实际情况修改上述内容。

全局安装

在全局安装之前,我们可以使用npm list -g来看看自己在特定node环境下,全局安装了啥。

然后,我们使用npm i @cli/cli -g来全局安装。由于我本地已经安装过了,这里就不贴图了。

我们可以使用npm list -g来查看是否安装成功,亦或者直接在控制台中输入front_cli命令。

反正,只有不是提示没对应的文件那就是安装成功了。然后,我们就可以开开心心的使用这个命令了。

完美完结🎉🎉🎉🎉


后记

「分享是一种态度」

「全文完,既然看到这里了,如果觉得不错,随手点个赞和“在看”吧。」

alt

Reference

[1]

f_cli_f: https://www.npmjs.com/package/f_cli_f

[2]

package.json_bin: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin

[3]

gitlab官网: https://docs.gitlab.com/ee/api/rest/#oauth-20-tokens

本文由 mdnice 多平台发布

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/674453.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

进程通信——管道

什么是进程通信&#xff1f; 进程通信是实现进程间传递数据信息的机制。要实现数据信息传递就要进程间共享资源——内存空间。那么是哪块内存空间呢&#xff1f;进程间是相互独立的&#xff0c;一个进程不可能访问其他进程的内存空间&#xff0c;那么这块空间只能由操作系统提…

私有化部署的无忧企业文档,助力企业实现文档权限的精细化管理

在当今数字化快速发展的时代&#xff0c;企业文档管理已成为企业运营中不可或缺的一部分。文档的安全性和访问权限的精确控制对于企业的信息保护至关重要。在无忧企业文档管理系统中&#xff0c;不仅具备强大的内容管理能力&#xff0c;更在权限管理上做到了细致入微。下面我对…

完全背包(类买卖股票问题)

题目传送门——纪念品 题解&#xff1a;这题我一开始以为是简答的那个买卖股票问题&#xff0c;但是做了之后发现并没有那么简单&#xff0c;但是经过思考时候&#xff0c;我发现其和完全背包类问题差不多&#xff0c;怎么说呢&#xff0c;我们首先用p[i][j]去统计每天每种物品…

手写最小的 Agent 系统 — Tiny Agent

调研Agent核心思想&#xff0c;主要有metagpt、React、Reflexion、Toolformer、Swiftsage、Creator等等。Tiny Agent 实现&#xff0c;主要包括 构造大模型、构造工具、构造Agent、运行Agent等步骤。 Agent 核心思想 1. MetaGPT METAGPT: META PROGRAMMING FOR A MULTI-AGEN…

bugku 隐写

说明&#xff1a; 隐写&#xff0c;通过改变图片的大小&#xff0c;即修改了高或者宽&#xff0c;达到隐写flag&#xff0c;要求修改会图片的真实大小找到flag。 1、打开图片 2、使用010editor工具打开图片 通过最下面黄底字的错误提示&#xff0c;表示CRC不匹配&#xff0c;…

如何创建一个Angular项目(超简单)

1、安装Node.js&#xff08;官网Node.js下载&#xff09; 2、运行node -v和npm -v两条命令&#xff08;检验是否下载成功Node.js&#xff09; 3、npm i -g cnpm --registryhttps://registry.npmmirror.com&#xff08;用npm安装cnpm&#xff0c;将镜像源设置为国内镜像源&…

python办公自动化——(三)替换PPT文档中图形数据-折线图

数据替换前 数据替换后 代码实现 # 单折线 pathE:\\13 python 下侧双x轴折线图\\ prs Presentation(path双x轴测试-01.pptx) data_timepd.read_excel(path"数据.xlsx",sheet_name单折线)ppt_9prs.slides…

汽车识别项目

窗口设计 这里的代码放在py文件最前面或者最后面都无所谓 # 创建主窗口 window tk.Tk() window.title("图像目标检测系统") window.geometry(1000x650) # 设置窗口大小# 创建背景画布并使用grid布局管理器 canvas_background tk.Canvas(window, width1000, height…

BugKu 哎,就是玩

说明&#xff1a;通过图片隐写找到迷宫压缩包解码密码&#xff0c;然后通过MG游戏得到井字棋游戏解压密码&#xff0c;最后通过完成井字棋得到flag. 打开实验包&#xff0c;解压后可以看到两个文件。 首先要通过TKR.png找到迷宫.zip的解压密码。 打开图片&#xff0c;发现图片…

二叉树创建和遍历

个人主页 &#xff1a;敲上瘾-CSDN博客二叉树介绍&#xff1a;二叉树(详解)-CSDN博客 目录 一、二叉树的创建 二、二叉树的遍历 1.前序遍历 2.中序遍历 3.后序遍历 4.层序遍历 三、相关计算 1.总节点个数计算 2.叶子节点个数计算 3.深度计算 一、二叉树的创建 关于…

24.6.2(动态开点线段树)

星期一&#xff1a; cf edu round 36 E cf传送门 题意&#xff1a;1到n天初始全为工作日&#xff0c;有两种操作&#xff0c;将 l-r 区间变为 工作日/休息日&#xff0c;每次操作后询问剩余总工作日有多少 思路&…

AIGC绘画设计基础——“这是我学一天AI设计后的作品,效率真的高。”

不少小伙伴都在用Midjourney生成图像作品&#xff0c;但对于完整的设计流程却不太熟悉。今天数艺君就跟大家分享一个干货内容&#xff1a;使用Midjourney设计一个动物IP形象&#xff01; 包含整个项目流程&#xff1a;从项目背景到需求分析&#xff0c;再到出图思路和提示词设计…

Paper Survey——3DGS-SLAM

之前博客对多个3DGS SLAM的工作进行了复现及代码解读 学习笔记之——3DGS-SLAM系列代码解读_gs slam-CSDN博客文章浏览阅读1.9k次&#xff0c;点赞15次&#xff0c;收藏45次。最近对一系列基于3D Gaussian Splatting&#xff08;3DGS&#xff09;SLAM的工作的源码进行了测试与…

竞赛 基于视觉的身份证识别系统

0 前言 &#x1f525; 优质竞赛项目系列&#xff0c;今天要分享的是 基于机器视觉的身份证识别系统 该项目较为新颖&#xff0c;适合作为竞赛课题方向&#xff0c;学长非常推荐&#xff01; &#x1f9ff; 更多资料, 项目分享&#xff1a; https://gitee.com/dancheng-sen…

GNeRF论文理解

文章目录 主要解决什么问题&#xff1f;结构设计以及为什么有效果&#xff1f;个人想法。 主要解决什么问题&#xff1f; 本文主要想要解决的问题是 如何使用uncalibrated的照片来进行Nerf重建。虽然说现在已经有了一些方式可以对相机位姿进行估计和优化&#xff0c;但是他们限…

速通systemverilog

这里写目录标题 一、systemverilog的大部分新语法logicalways_combunique_casepriority casealways_fftypedefstructenumunioninterface 二、实现流水灯三、全加器以及仿真 一、systemverilog的大部分新语法 logic always_comb unique_case priority case case中常量和变量互…

SAP-FICO总账科目案例

1、资产科目 2、负债科目

学习笔记之——2D Gaussian Splatting(2DGS)

3DGS在辐射场重建中取得了巨大的成就&#xff0c;实现高质量的新视图合成和快速渲染。最近新出了3DGS的升级版本&#xff0c;2DGS。写下本博文记录本人学习及测试2DGS的过程&#xff0c;本博文仅为本人学习记录用~ Project WebsiteGithub CodeOriginal paper 目录 原理解读 …

Vue3项目炫酷实战,检测密码强度值

在前端项目开发中&#xff0c;确保用户密码的强度是保护账户安全的重要措施。本文将演示如何使用Vue 3实现一个简单的密码强度检测功能。通过实时反馈&#xff0c;帮助用户创建更安全的密码&#xff0c;从而提升整体系统的安全性。无论您是前端开发新手还是经验丰富的开发者&am…

实验9 静态路由配置

实验9 静态路由配置 一、 原理描述二、 实验目的三、 实验内容四、 实验配置五、 实验步骤 一、 原理描述 网络中的每个路由器都会维护一张路由表或转发表。路由表的表项记录着目的网络信息以及下一跳I 地址。路由表可以手动配置&#xff0c;也可以通过路由算法动态生成。静态…