# grunt-git-dist

> Release using git

Latest version **0.4.1** (published 2014-01-20) · 0 weekly downloads

## Install

```sh
npm install grunt-git-dist
pnpm add grunt-git-dist
yarn add grunt-git-dist
bun add grunt-git-dist
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2014-01-20 |
| First published | 2013-05-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mikael Karon |
| Maintainers | mikael.karon |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-git-dist
- Repository: https://github.com/mikaelkaron/grunt-git-dist
- Issues: https://github.com/mikaelkaron/grunt-git-dist/issues
- npm.io page: https://npm.io/package/grunt-git-dist

## Dependencies (4)

- [grunt-util-spawn](https://npm.io/package/grunt-util-spawn.md) ~0.0.2
- [grunt-util-options](https://npm.io/package/grunt-util-options.md) ~0.0.2
- [grunt-util-process](https://npm.io/package/grunt-util-process.md) ~0.0.1
- [grunt-util-required](https://npm.io/package/grunt-util-required.md) ~0.0.1

## Recent versions

- 0.4.1 (latest) — 2014-01-20
- 0.4.0 — 2013-09-16
- 0.3.1 — 2013-08-28
- 0.3.0 — 2013-07-18
- 0.2.3 — 2013-07-01
- 0.2.2 — 2013-06-21
- 0.2.1 — 2013-06-21
- 0.2.0 — 2013-06-21
- 0.1.1 — 2013-05-07
- 0.1.0 — 2013-05-07

## README

[![Build Status](https://travis-ci.org/mikaelkaron/grunt-git-dist.png)](https://travis-ci.org/mikaelkaron/grunt-git-dist)
[![NPM version](https://badge.fury.io/js/grunt-git-dist.png)](http://badge.fury.io/js/grunt-git-dist)

# grunt-git-dist

> Release using git

## Getting Started
This plugin requires Grunt `~0.4.0`

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-git-dist --save-dev
```

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-git-dist');
```

## The "git-dist" task

### Overview
In your project's Gruntfile, add a section named `git-dist` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  "git-dist" : {
    "options" : {
      "url" : "<%= pkg.repository.url %>",
      "branch" : "build/2.x",
      "dir" : "<%= build.dist %>",
      "paths" : [ "path/to/dir", "path/to/file.ext" ],
      "message" : "<%= pkg.name %> - <%= pkg.version %>",
      "tag" : "<%= pkg.version %>",
      "config" : {
          "user.name" : "<%= pkg.author.name %>",
          "user.email" : "<%= pkg.author.email %>",
      },
      "empty" : true
    },
    "your_target": {
      // Target-specific file lists and/or options go here.
    },
  },
})
```

> Note that since this is a [multi-task](http://gruntjs.com/creating-tasks#multi-tasks) you have to have at least one target defined for `git-dist` (otherwise the task won't run)

### Options

#### options.url
Type: `String`  
Default value: `undefined`

A string value that is used to select what repository to clone. If empty the current repository will be used.

#### options.branch
Type: `String`  
Default value: `undefined`

A string value that is used to select what branch to clone.

#### options.dir
Type: `String`  
Default value: `undefined`

A string value that is used to select what dir to clone to.

#### options.paths
Type: `Array`  
Default value: `undefined`

An array value that is used to select wich files to add.

#### options.message
Type: `String`  
Default value: `undefined`

A string value that is used as a commit/tag message.

#### options.config
Type: `Object`
Default value: `undefined`

An object value that is used to configure the clone.

#### options.tag
Type: `String`  
Default value: `undefined`

A string value that is used as the tag name.

#### options.empty
Type: `Boolean`  
Default value: `undefined`

A boolean value that is used to allow empty commits.

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History

0.4.0 - Added `add` phase. Regular add removed from `commit` phase  
0.3.1 - Added standardized support for CLI parameters  
0.3.0 - Added `init` and `tag` phase.
0.2.3 - Removed `configure` phase. Instead we configure during clone  
0.2.2 - Added support for `empty`  
0.2.1 - Realized that we can support URL, so added it back  
0.2.0 - Remove support for URL as we always clone the local repository  
0.1.1 - Fix so deleted files are tracked  
0.1.0 - Initial release

---
_Source: https://npm.io/package/grunt-git-dist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._