Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cypress-io/commit-info
Collects Git commit info using git
https://github.com/cypress-io/commit-info
api cli commit git utility
Last synced: 8 days ago
JSON representation
Collects Git commit info using git
- Host: GitHub
- URL: https://github.com/cypress-io/commit-info
- Owner: cypress-io
- Created: 2017-10-28T01:33:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-21T07:27:56.000Z (about 1 year ago)
- Last Synced: 2024-05-09T21:29:51.978Z (8 months ago)
- Topics: api, cli, commit, git, utility
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 17
- Watchers: 14
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @cypress/commit-info
> Collects Git commit info from git CLI
[![NPM][npm-icon] ][npm-url]
[![Build status][ci-image] ][ci-url]
[![semantic-release][semantic-image] ][semantic-url]
[![js-standard-style][standard-image]][standard-url]
[![renovate-app badge][renovate-badge]][renovate-app]
## Install
Requires [Node](https://nodejs.org/en/) version 6 or above.
```sh
npm install --save @cypress/commit-info
```
## Use
```js
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
})
```
Notes:
- Code assumes there is `.git` folder and uses Git commands to get each property, like `git show -s --pretty=%B`, see [src/git-api.js](src/git-api.js). Note: this can be overrided by environment variables.
- Resolves with [Bluebird](https://github.com/petkaantonov/bluebird) promise.
- Only uses Git commands, see [src/git-api.js](src/git-api.js)
- If a command fails, returns `null` for each property
- If you need to debug, run with `DEBUG=commit-info` environment variable.
## Override with environment variables
If getting the commit information using `git` fails for some reason, or you want to override them, you can provide the commit information by setting the environment variables. This module will look at the following environment variables as a fallback
```
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
```
### For Docker containers
When running your application inside a Docker container, you should set these environment variables using `-e` syntax.
```shell
$ docker run \
-e COMMIT_INFO_BRANCH=develop \
-e COMMIT_INFO_SHA=e5d9eb66474bc0b681da9240aa5a457fe17bc8f3 \
```
See [docker-example](docker-example) for a full example.
## Individual methods
In addition to `commitInfo` this module also exposes individual promise-returning
methods `getBranch`, `getMessage`, `getEmail`, `getAuthor`, `getSha`, `getTimestamp`, `getRemoteOrigin`. These methods do NOT use fallback environment variables.
For example
```js
const {getAuthor} = require('@cypress/commit-info')
getAuthor('path/to/repo')
.then(name => ...)
```
### getBranch
Resolves with the current git branch name or `null`.
```js
const {getBranch} = require('@cypress/commit-info')
getBranch()
.then(branch => ...)
```
- If this is detached commit (reporting `HEAD`), returns `null`
### Small print
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
[open issue](https://github.com/cypress-io/commit-info/issues) on Github
## MIT License
Copyright (c) 2017 Cypress.io
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[npm-icon]: https://nodei.co/npm/@cypress/commit-info.svg?downloads=true
[npm-url]: https://npmjs.org/package/@cypress/commit-info
[ci-image]: https://github.com/cypress-io/commit-info/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/cypress-io/commit-info/actions/workflows/main.yml
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/