@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 和凭据
  url: '<git URL>', // 必填
  token: '<git 令牌>', // 必填,如果未提供用户名和密码
  username: '<git 用户名>', // 必填,如果未提供令牌
  password: '<git 密码>' // 必填,如果未提供令牌
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // 获取当前提交
const commitTime1 = await repository.currentCommitTime() // 获取当前提交的时间(毫秒)

await repository.checkout('<目标提交>') // 可以是分支、标签或提交
const commit2 = await repository.currentCommit() // 获取当前提交

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

创建新的本地存储库

当您将 config 作为 null 传递时,它将在本地路径中创建一个新存储库。

await git(null, path1)

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