@sumor/git

git

Sumor Cloud 工具。
更多文档

一个 git 版本库,可以轻松打包版本,并使用环境生成特定包。

NPM 版本 NPM 下载量 GitHub CI GitHub 测试 GitHub 覆盖率 GitHub 审核

安装

npm i @sumor/git --save

先决条件

Node.JS 版本

需要 Node.JS 版本 18.x 或以上

需要 Node.JS ES 模块

由于此包是以 ES 模块编写的, 请在您的 package.json 文件中更改以下代码:

{
  "type": "module"
}

用法

import git from '@sumor/git'
const config = {
  // git url and credentials
  url: '<git url>', // 必填
  token: '<git token>', // 如果未提供用户名和密码,则为必填
  username: '<git username>', // 如果未提供令牌,则为必填
  password: '<git password>' // 如果未提供令牌,则为必填
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // 获取当前提交

const commit2 = await repository.checkout('<target commit>') // 可以是分支、标签或提交

// 如果安装了 Github Desktop,可以使用以下命令在 Github Desktop 中打开
await repository.github()

创建新的本地仓库

如果将 null 作为配置传递,它会在本地路径中创建一个新的仓库。

await git(null, path1)

// 本地仓库的用法
const repository = await git({ url: path1 }, path2)