@ cypress/ 承诺- info
收藏 Git 来自 git CLI 的信息
安装
要求数 节点 6或以上版本.
npm install --save @cypress/commit-info
使用
const { commitInfo } = require('@cypress/commit-info')
// default folder is current working directory
commitInfo(folder)
.then(info => {
// info object will have properties
// branch
// message
// email
// author
// sha
// timestamp (in seconds since epoch)
// remote
})
注释:
- 代码假设
.git文件夹并使用 Git 命令获取每个属性, 如git show -s --pretty=%B,参见 src/git-api.js (英语)。注意:这可由环境变量所取代. - 决定: 青鸟 答应.
- 只使用 Git 命令, 参见 src/git-api.js (英语)
- 如果命令失败, 返回
null每个财产 - 如果您需要调试, 请使用
DEBUG=commit-info环境变量.
覆盖环境变量
如果使用 git 由于某种原因失败,或者想要覆盖它们,您可以通过设置环境变量来提供承诺信息. 此模块将查看以下环境变量作为后退
branch: COMMIT_INFO_BRANCH
message: COMMIT_INFO_MESSAGE
email: COMMIT_INFO_EMAIL
author: COMMIT_INFO_AUTHOR
sha: COMMIT_INFO_SHA
timestamp: COMMIT_INFO_TIMESTAMP
remote: COMMIT_INFO_REMOTE
嵌入容器
在 Docker 容器内运行应用程序时,您应该使用 -e 语法.
$ docker run \
-e COMMIT_INFO_BRANCH=develop \
-e COMMIT_INFO_SHA=e5d9eb66474bc0b681da9240aa5a457fe17bc8f3 \
<container name>
见 插件实例 一个完整的例子.
个别方法
何况 commitInfo 本单元还揭示了个人承诺的回归
方法 getBranch, (中文(简体) ), getMessage, (中文(简体) ), getEmail, (中文(简体) ), getAuthor, (中文(简体) ), getSha, (中文(简体) ), getTimestamp, (中文(简体) ), getRemoteOrigin。这些方法不使用倒置环境变量.
举个例子
const {getAuthor} = require('@cypress/commit-info')
getAuthor('path/to/repo')
.then(name => ...)
获取缓冲
以当前 git 分支名称或 null。 。 。 .
const {getBranch} = require('@cypress/commit-info')
getBranch()
.then(branch => ...)
- 如果这是分离的(报告)
HEAD),返回时null
小印数
许可:麻省理工学院 - 做任何与代码有关的事情, 但如果它不起作用,不要责怪我.
支持: 如果您发现此模块有任何问题, 电子邮件 / 微博 / 未决问题 在基图布
MIT 许可证
版权(c)2017 Cypress.io
特此免费准许任何人 获取该软件和相关文件的副本 文件(“软件”),在软件中处理,不包含 限制,包括不限制使用权, 复制、修改、合并、出版、发行、分版和/或销售 软件的复制本,并允许向 为此提供了软件,但须符合下列条件: 条件:
上述版权通知和本许可通知应为: 列入软件的所有副本或大部分.
软件是提供的"是", 没有任何种类的恐惧, 或监禁,包括但不限制于 特别目的和目的的证明 无所不入。 绝对不能让警察或警察 B. 任何索赔、救济或其他负债的持有者, 条约、条约或其他条约行动 来源、来源或与溶剂或使用有关的 其他交易 在软件.