git-raw-commits
Advanced tools
Package description
The git-raw-commits npm package is designed to generate raw git commits from your repository's history. It allows developers to programmatically access commit information, which can be useful for generating changelogs, analyzing project history, or automating versioning processes.
Generating raw commits
This feature allows you to generate raw commit data between two tags (from 'v1.0.0' to 'v2.0.0' in this example). The output can be piped to any writable stream, such as `process.stdout` for display or a file stream for saving.
const gitRawCommits = require('git-raw-commits');
gitRawCommits({ from: 'v1.0.0', to: 'v2.0.0' }).pipe(process.stdout);Filtering commits
This feature demonstrates how to filter commits by a specific pattern using the `grep` option. In this example, only commits with 'Fix' in their messages between 'v1.0.0' and the latest commit ('HEAD') are generated.
const gitRawCommits = require('git-raw-commits');
gitRawCommits({ from: 'v1.0.0', to: 'HEAD', grep: 'Fix' }).pipe(process.stdout);Similar to git-raw-commits, conventional-changelog is a tool for generating changelogs based on semantic versioning and commit conventions. While git-raw-commits provides raw commit data, conventional-changelog processes this data to create formatted changelog entries, offering a higher-level abstraction.
gitlog is another npm package that allows you to retrieve commit logs from your git repository. Compared to git-raw-commits, gitlog offers a simpler interface for accessing commit information but lacks the fine-grained control over commit selection and formatting.
Readme
Get raw git commits out of your repository using git-log(1)
$ npm install --save git-raw-commits
var gitRawCommits = require('git-raw-commits');
gitRawCommits(options)
.pipe(...);
Returns a readable stream. Stream is split to break on each commit.
Type: object
Please check the available options at http://git-scm.com/docs/git-log. NOTE: Single dash arguments are not supported because of https://github.com/sindresorhus/dargs/blob/master/index.js#L5.
NOTE: for <revision range> we can also use <from>..<to> pattern, and this module has the following extra options for shortcut of this pattern:
Type: string Default: ''
Type: string Default: 'HEAD'
This module also have the following additions:
Type: string Default: '%B'
Please check http://git-scm.com/docs/git-log for format options.
Type: function
A function to get debug information.
Type: string or array
Filter commits to the path(s) provided.
Options to pass to git childProcess
Type: object
Type: string
Current working directory to execute git in
$ npm install --global git-raw-commits
$ git-raw-commits --help # for more details
MIT © Steve Mao
FAQs
Get raw git commits out of your repository using git-log(1)
The npm package git-raw-commits receives a total of 2,950,140 weekly downloads. As such, git-raw-commits popularity was classified as popular.
We found that git-raw-commits demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.