Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jantimon/grunt-githash
Grunt plugin to get the current git hash, branch and tag
https://github.com/jantimon/grunt-githash
Last synced: 28 days ago
JSON representation
Grunt plugin to get the current git hash, branch and tag
- Host: GitHub
- URL: https://github.com/jantimon/grunt-githash
- Owner: jantimon
- Created: 2015-02-11T10:16:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-27T19:53:28.000Z (over 7 years ago)
- Last Synced: 2024-08-09T22:10:33.976Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# grunt-githash
[](https://travis-ci.org/jantimon/grunt-githash)
[](http://badge.fury.io/js/grunt-githash)
[](https://david-dm.org/jantimon/grunt-githash)
> Grunt plugin to get the current git hash, git branch and git tag
## Getting Started
This plugin requires Grunt.
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-githash --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-githash');
```
## The "githash" task
### Overview
In your project's Gruntfile, add a section named `githash` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
githash: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```
### Options
#### options.dir
Type: `String`
Default value: `'.'`
#### options.fail
Type: `Boolean`
Default value: `true`
Reports a warning if not inside a git respository
### Available values
#### githash.{target}.branch
Type: `String`
Value: branch name
#### githash.{target}.tag
Type: `String`
Value: tag name
#### githash.{target}.hash
Type: `String`
Value: the full hash value
#### githash.{target}.short
Type: `String`
Value: the short git hash value
### Usage Examples
#### Default Options
In this example, the default options are used to get the git status.
```js
grunt.initConfig({
githash: {
main: {
options: {},
}
},
anotherTask: {
options: {
exampleOptions1: '<%= githash.main.hash %>',
exampleOptions2: '<%= githash.main.hash %> <%= githash.main.tag %> <%= githash.main.branch %>',
exampleOptions3: '<%= githash.main.short %>'
}
}
})
```
#### Custom Options
In this example, we define the git repository location
```js
grunt.initConfig({
githash: {
submodule: {
options: {
// Git repository path (e.g. a git sub module)
dir: 'sub/repository/'
}
}
},
anotherTask: {
options: {
someProp: '<%= githash.submodule.hash %>'
}
}
})
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## License
Copyright (c) 2015 Jan Nicklas. Licensed under the MIT license.