码迷,mamicode.com
首页 > 其他好文 > 详细

以zico为例讲解基于GitHub Packages发布npm包全过程

时间:2020-07-13 09:23:31      阅读:74      评论:0      收藏:0      [点我收藏+]

标签:手机   lin   ice   尼玛   证书   oom   anon   class   The   

话说2019年,微软通过github收购了npm,这二者从此就是好兄弟了,他们的官网也都宣称是一家。
那是不是通过github可以方便的发布npm包呢?
答案是肯定的。
可惜国内开源不振,很少有这方面的文章。

碰壁:开始操作

刚好作者手上维护着国内矢量图标库zico,这不就动手做起来了。

github官网,在仓库一则有提示,似乎点击就能发布:
技术图片

结果点进去,按操作,就发现太幼稚了。

其界面提示:

  // Step 1: Use `publishConfig` option in your package.json
  "publishConfig": { "registry": "https://npm.pkg.github.com/" }
  // Step 2: Authenticate
  $ npm login --registry=https://npm.pkg.github.com/
   
  // Step 3: Publish
  $ npm publish

结果,按此信息填写是死活提不了,会报404的错。
事实上,在发布时并不需要publishConfig定义,要删除:

  "publishConfig": {
    "registry": "https://npm.pkg.github.com/"
  },

以zico项目为例,其完整的package.json定义如下:

  {
  "name": "zico",
  "version": "1.9.1",
  "description": "A web icon framework by Zoomla!CMS team,一个专为中国开发者而生的跨平台图标解决方案|基于zico技术可快速渲染webfont或svg矢量图标,并提供免费的网页字体,由知名的Zoomla!逐浪CMS团队维护",
  "main": "index.html",
  "scripts": {
  "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
  "webfont",
  "网站图标",
  "web图标",
  "svg图标",
  "China图标",
  "China icons",
  "JS图标",
  "东方图标",
  "中国图标",
  "逐浪图标",
  "手机图标",
  "字体图标",
  "医疗图标",
  "矢量图标",
  "保真图标",
  "中国图标",
  "政务图标",
  "免费图标",
  "CMS图标",
  "中国企业ico",
  "中国百强企业图标"
  ],
  "author": "Shanghai Zoomla!CMS Software co.,ltd",
  "license": "MIT",
  "directories": {
  "lib": "lib"
  },
  "repository": {
  "type": "git",
  "url": "git+https://github.com/zoomla/zico.git"
  },
  "bugs": {
  "url": "https://github.com/zoomla/zico/issues"
  },
  "homepage": "https://ico.z01.com"
  }

授权npm token

技术图片

生成好了大概长这个样子 1c14ee16-xxxx-4ae3-b09f-faca87axxxx (注:已做脱敏处理

加入 GitHub 项目的 secrets 里
技术图片

github授权发布

发布时,有人说需要加上包的域,事实我操作时没有遇到。
为了方便用户,我还是摘抄如下(建议实际操作时,将加@域的方法剔除试试)。

首先,GitHub Packages只支持作用域包,所以一开始的包名需要改一下,叫@xxxx/yyyy。
最好先发布下,看能不能发布成功,如果发布失败,那就使用命令npm publish —access=public进行发布,让作用域包先能发布成功。
代码提交上传至github就不说了。
然后点击packages,第一步有个配置,先在package.json里配上:

  "publishConfig": {
  "registry": "https://npm.pkg.github.com/@yehuozhili"
  },

把我的作用域名改成你的就行了。

第二步比较坑爹,我一开始没懂为啥老失败,这里有2个坑。
第一个坑是命令,命令应该是这样:
npm login —registry=https://npm.pkg.github.com —scope=@yehuozhili

后面的–scope= 换成你们自己的作用域名。尼玛这个配置就写了前半段,作用域名没说咋加,让我搞半天。

第二个坑就是密码。我一开始以为是npm账号密码,结果尼玛居然不是的,搞了半天密码是githubtoken,主要是输入密码是一片空白,也看不见输入了啥,居然要的是token有点不合常理。你粘贴都看不见粘上没有。

githubtoken生成方法:
1.点击你的GitHub头像,选择下拉框中的“settings”:
技术图片

2:选择左侧菜单的“Developer settings”一项:

技术图片

3:选择“Personal access tokens”:

技术图片

4点击“Generate a personal access token”:
技术图片

5:把以下选项全部勾选,然后点击下方绿色按钮,便可生成一个token。

技术图片

这2个配置成功后就没问题了。
最后使用npm publish 发包即可在github的packages里看自己的包。
注意:npm删除包是非常复杂的操作,一般不推荐。

操作总结

  • 1.提交github
  • 2.关联npm与github证书
  • 3.提交好git后,第一步输入npm login --registry=https://npm.pkg.github.com/提交npm,接下来出现用户名,输入npm用户名,密码项则需要输入github token,
  • 3.最后点npm publish提交。

一个成功的关联的库:
https://github.com/zoomla/zico

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

以zico为例讲解基于GitHub Packages发布npm包全过程

标签:手机   lin   ice   尼玛   证书   oom   anon   class   The   

原文地址:https://www.cnblogs.com/zoomlaCMS/p/13291470.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!