@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的token>', // 如果未提供用户名和密码,则必填
  username: '<git的用户名>', // 如果未提供token,则必填
  password: '<git的密码>' // 如果未提供token,则必填
}
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, 路径1)

// 本地仓库的用法
const repository = await git({ url: 路径1 }, 路径2)