首页 > 其他分享 >图文并茂教你如何发布自己的NPM包(GitHub Packages npm 包发布)

图文并茂教你如何发布自己的NPM包(GitHub Packages npm 包发布)

时间:2024-10-30 22:41:42浏览次数:5  
标签:NPM npm notice GitHub layout 插件 test

前情提要

发布包到npm也好,到github packages仓库也好,都是一样的道理,只是仓库地址不一样而已,本文是将npm包发布到了GitHub Packages~

GitHub Packages 简介

GitHub Packages 是一种软件包托管服务,和npm类似,允许您私下或公开托管软件包,并将包用作项目中的依赖项。

快速上手

仓库准备

大家看一下:未发过包的仓库是下面这个样子

准备好自己需要发包的项目

切换为私有仓库

npm config set registry https://私有的git仓库.com/_registry/npm

获取当前npm仓库地址

npm config get registry

生成登录秘钥

登录

npm login

实际登录案例

PS C:\Users\test-layout> npm login
npm WARN adduser `adduser` will be split into `login` and `register` in a future version. `adduser` will become an alias of `register`. `login` (currently an alias) will become its own command.
npm notice Log in on https://test.com/_registry/npm
Username: xiaojin
Password:
Email: (this IS public) [email protected]
Logged in as xiaojin on https://test.com/_registry/npm.
PS C:\Users\test-layout> 

准备 package.json 文件:

package.json 是描述 NPM 包的核心文件,需要包含下面字段:

  • name:插件的名称,必须唯一且没有与其他包冲突。
  • version:插件的版本号,遵循语义化版本规则。
  • description:插件的简短描述。
  • main:指向插件的入口文件。
  • keywords:插件的关键词,有助于搜索引擎发现你的包。
  • author 和 license:插件的作者信息和许可证。

设置 NPM 忽略文件

创建 .npmignore 文件,指定例如,node_modules、dist 等。

版本管理

在 NPM 上发布的每个包都有唯一的版本号。如果你对插件做了更改,发布的时候需要更新版本号。NPM 使用语义化版本控制 (Semantic Versioning),其格式为 MAJOR.MINOR.PATCH。具体规则如下:

  • MAJOR:做了不兼容的 API 修改。
  • MINOR:增加了功能,并且没有破坏兼容性。
  • PATCH:修复了问题,并且没有破坏兼容性。

发布插件

npm publish

发布成功


PS C:\Users\testlayout> npm publish
npm notice 
npm notice 

标签:NPM,npm,notice,GitHub,layout,插件,test
From: https://www.cnblogs.com/sugartang/p/18516683

相关文章

  • NPM 包开发与优化全面指南
    1.理解NPM包的结构1.1package.json文件:包的核心1.2理解包的入口点2.深入理解模块格式2.1CommonJS(CJS)2.2ECMAScript模块(ESM)2.3通用模块定义(UMD)3.高级包优化技术3.1TreeShaking和副作用3.2代码分割和动态导入3.3条件......
  • 使用 FastGPT 工作流搭建 GitHub Issues 自动总结机器人
    如今任何项目开发节奏都很快,及时掌握项目动态是很重要滴,GitHubIssues一般都是开发者和用户反馈问题的主要渠道。然而,随着Issue数量的增加,及时跟进每一个问题会变得越来越困难。为了解决这个痛点,我们开发了一个自动化Issue总结机器人,它的功能很简单:自动获取项目最新的Gi......
  • 前端开发 npm ,pnpm
    npmpnpm通过npm安装pnpm安装npminstall-gpnpm安装指定版本[email protected]或者npminstall-gpnpm@X查看当前pnpm版本pnpm-v或pnpm-version卸载npmrm-gpnpm升级版本pnpmadd-gpnpmtoupdate常用命令对比npm命令pnpm......
  • 全网爆火神书《从零构建大模型》分享,尚未发布,GitHub标星22k!
    本书介绍《从零构建大模型》是一本即将于今年10月底发布的书籍,github已经吸引了惊人的21.7k标星!作者是威斯康星大学麦迪逊分校的终身教授,在GitHub、油管、X上拥有大量粉丝,是一位真正的大佬。本书免费获取地址:在本书中,读者将从内到外了解LLM的工作原理。在这本富有洞......
  • github fork 及 pull requests 流程
    1.从原始仓库fork到自己的仓库 2.clone自己仓库的代码到本地gitclonehttps://xxxx.git 3.添加upstream(git地址为原始仓库地址,添加后可对原始仓库进行拉取和推送)gitremoteaddupstreamhttps://xxx.git 4.本地拉取原始仓库最新代码gitfetchupstream......
  • GitHub Star 数量前 5 的开源应用程序生成器
    欢迎来的GitHubStar数量排名系列文章的第7篇——最受欢迎的应用程序生成器。之前我们已经详细探讨过:在GitHub上最受欢迎的——无代码工具、低代码项目、内部工具、CRUD项目、自部署项目和Airtable开源替代品。累计超过50个优质项目!(......
  • 2024年10月28日Github流行趋势
    项目名称:Skyvern-AI/skyvern项目维护者:@ykeremy@wintonzheng@LawyZheng@msalihaltun@suchintan项目介绍:使用LLMs和计算机视觉实现基于浏览器的工作流程自动化。项目star数:8,730项目fork数:566项目名称:anthropics/courses项目维护者:@Colt@alexalbertt@rainl......
  • Vue项目在npm install 报版本错误 解决方案
    1.在npminstall后提示版本npm过高的解决办法:npm降级:比如现在的版本是8.XX.XX,想要还原到6.XX.XX:[email protected].删除npm缓存,执行清楚缓存命令在降级前需要打开win+R,输入%appdata%找到npm以及npm-cache删除这两个包,并且执行npmcacheclean--force清空缓......
  • mac电脑通过 npm 安装 @vue/cli脚手架超时问题;
    npm安装@vue/cli遇到的问题步骤一、安装Homebrew如果你还没有安装Homebrew,首先需要安装它。Homebrew是macOS上的一款包管理工具,它允许你通过简单的命令行指令安装、更新和卸载软件包。;1,打开终端(Terminal)。2,运行以下命令来安装Homebrew(国内用户推荐使用国内......
  • github下载加速[findstr修改hosts]
    @echooffremcolor1fsettitle=github下载加速[修改hosts]title%title%set"HOSTS_PATH=%windir%\system32\drivers\etc\hosts"REM备份原始的hosts文件copy"%HOSTS_PATH%""%HOSTS_PATH%.bak"rem使用findstr获取最后一行setnumber=0for/f"de......