git-revision-webpack-plugin

What is git-revision-webpack-plugin?

The git-revision-webpack-plugin is a Webpack plugin that allows you to embed Git revision information into your build. This can be useful for versioning, debugging, and tracking the state of your codebase at the time of the build.

What are git-revision-webpack-plugin's main functionalities?

Embed Git Revision Information

This feature allows you to embed the current Git revision information into your Webpack build. The code sample shows how to include the GitRevisionPlugin in your Webpack configuration.

const GitRevisionPlugin = require('git-revision-webpack-plugin');
const gitRevisionPlugin = new GitRevisionPlugin();

module.exports = {
  plugins: [
    gitRevisionPlugin
  ]
};

Access Git Information in Code

This feature allows you to access Git information such as the version, commit hash, and branch name directly in your code. The code sample demonstrates how to log this information to the console.

const GitRevisionPlugin = require('git-revision-webpack-plugin');
const gitRevisionPlugin = new GitRevisionPlugin();

console.log('Version:', gitRevisionPlugin.version());
console.log('Commit Hash:', gitRevisionPlugin.commithash());
console.log('Branch:', gitRevisionPlugin.branch());

Define Global Constants

This feature allows you to define global constants in your Webpack configuration that hold Git information. The code sample shows how to use the DefinePlugin to create global constants for the version, commit hash, and branch name.

const GitRevisionPlugin = require('git-revision-webpack-plugin');
const gitRevisionPlugin = new GitRevisionPlugin();

module.exports = {
  plugins: [
    new webpack.DefinePlugin({
      'VERSION': JSON.stringify(gitRevisionPlugin.version()),
      'COMMITHASH': JSON.stringify(gitRevisionPlugin.commithash()),
      'BRANCH': JSON.stringify(gitRevisionPlugin.branch())
    })
  ]
};

Other packages similar to git-revision-webpack-plugin

webpack-build-info-plugin

The webpack-build-info-plugin is a Webpack plugin that provides build information including Git commit hash, branch name, and build timestamp. It is similar to git-revision-webpack-plugin but also includes additional build metadata.

webpack-git-revision

The webpack-git-revision plugin is another alternative that focuses on embedding Git revision information into your Webpack build. It provides similar features to git-revision-webpack-plugin but with a different API.

README

Git Revision Webpack Plugin

Simple webpack plugin that generates VERSION and COMMITHASH files during build based on a local git repository.

Usage

npm install --save-dev git-revision-webpack-plugin

Sample webpack config:

var GitRevisionPlugin = require('git-revision-webpack-plugin')

module.exports = {
  plugins: [
    new GitRevisionPlugin()
  ]
}