Gitlab私有npm包构建

1,234 阅读3分钟

前言:

很久没发博客,时间进入2022年,更加忙碌更加卷,其实平时积攒了不少笔记,但都没时间转化为博客

2022年主要核心是 vue3 + ts 开发,踩过很多坑,躺过很多雷,后续有空会陆续把 vue3 + ts 学习一些值得分享的内容写出来

新建私有 npm 模块

  1. 在 Gitlab 新建一个组,名为 kk
  2. 新建组 kk 里新建一个项目 kk-cms
  3. 将 kk-cms 克隆到本地开发环境
  4. 打开 kk-cms 终端执行 npm init --scope=kk 生成 package.json 文件
  5. 将 kk-cms 提交到 Gitlab 仓库

使用私有 npm 模块

  1. 在需要使用到项目 package.json 文件中添加依赖
"@kk/kk-cms":"git+http://git.your-inc.com/kk/kk-cms.git"
  1. 执行 npm install 或者 yarn 进行安装即可

更新私有 npm 模块

  1. npm install @kk/kk-cms 或 yarn upgrade @kk/kk-cms

问题&解决

  1. 执行 yarn 进行包安装时报错“Exit code: 128”
    清空 yarn 到缓存文件重新安装即可,路径/Users/yourName/Library/Caches/Yarn/v1/.tmp/

参考

上面这段更清晰,感觉就很简单了

创建群组

 

可以在这里查看群组


群组创建项目

每个项目就是一个独立npm包;这个很重要请记住!!!

 项目的创建就比较随意了,不强制要求什么

项目ID等会要用要留意:


项目创建令牌

官网个人访问令牌详细说明:gitlab.com/help/user/p…

允许以只读权限访问镜像仓库;(不勾选)

read_package_registry允许对包注册表进行只读访问;(要勾选,不勾选就无法上传更新代码)

write_package_registry允许对包注册表进行读写访问;(要勾选,不勾选就无法上传更新代码) 

 

这个很重要只会出现一次,页面刷新后就没了,所以一定要记得保存下来

 


接下来到代码编写

在群组里拉取项目(怎么拉不用教了吧):

 


项目设置身份验证

官网教程:gitlab.com/help/user/p…

(基本都是私有公共项目不安全)

当项目是公共:则不需要身份验证。

 

当项目是私有:须通过包注册表进行身份验证

要进行身份验证,请使用以下方法之一:

使用个人访问令牌或部署令牌进行身份验证

要使用包注册表进行身份验证,您需要个人访问令牌或部署令牌。

 

项目级 npm 端点:群组内所有项目都可访问

实例级 npm 端点:只有项目自己能访问

本次教程只演示项目级 npm 端点,实例级 npm 端点基本不用

 

输入命令设置 npm 配置:npm config set -- '//gitlab.syc-cms.com/api/v4/projects/60/packages/npm/:_authToken' "这里填令牌"

  1. 字段解释:

1.1) gitlab.syc-cms.com // 公司内部gitlab网址

1.2) 60 // 项目ID

1.3) 人访问令牌

 


项目根目录创建 .npmrc 文件

官网教程:gitlab.com/help/user/p…

输入以下内容: @syc-web-packages:registry=gitlab.cms.syc/api/v4/pack…

字段解释:

2.1) syc-web-packages // 群组名

2.2) gitlab.syc-cms.com // gitlab网站地址

 


发布 npm 包

官网教程:gitlab.com/help/user/p…

项目 package.json 文件 publishConfig 字段添加以下内容: "@syc-web-packages:registry":"gitlab.syc-cms.com/api/v4/proj…"

  1. 字段解释:

1.1) publishConfig // 决定了我们发布包发布到哪里去,此时发布包就不是往 www.npmjs.com

1.2) syc-web-packages // 群组名

1.3) gitlab.syc-cms.com // gitlab网站地址

1.4) 60 // 项目ID

输入命令发布npm包到组:npm publish

每次发布包都要更新版本号:

在这里能看到刚才更新的包:

  1. 关于403报错

线上有同名且版本号一致的包则无法上传,gitlab包策略是递增更新不覆盖旧版本,实际上也可以手动删除旧包然后再上传

以上就是npm包的生产上传过程,接下来就是到项目中下载npm包


下载npm包

官网教程:gitlab.com/help/user/p…

设置群组包的下载地址:npm config set @syc-web-packages:registry gitlab.syc-cms.com:8443/api/v4/pack…

设置群组令牌:npm config set -- '//gitlab.syc-cms.com:8443/api/v4/packages/npm/:_authToken' "群组令牌"

  1. 字段解释:

1.1) syc-web-packages // 群组名

1.2) gitlab.syc-cms.com:8443 // gitlab网址:端口

1.3) mnsxssDZgo1X9xirE3TT // 群组令牌

 

根据群组内的包名下载npm包:npm install @syc-web-packages/test3

 

 

参考文章:

gitlab.com/help/user/p…

segmentfault.com/a/119000000…