# grunt-gandi-deploy

> Help deploying apps on Gandi Simple Hosting using Git.

Latest version **0.1.2** (published 2016-04-01) · 0 weekly downloads

## Install

```sh
npm install grunt-gandi-deploy
pnpm add grunt-gandi-deploy
yarn add grunt-gandi-deploy
bun add grunt-gandi-deploy
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2016-04-01 |
| First published | 2016-04-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Olivier GRAZIANO |
| Maintainers | oliviergraziano |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-gandi-deploy
- Repository: https://github.com/oliviergraziano/grunt-gandi-deploy
- Issues: https://github.com/oliviergraziano/grunt-gandi-deploy/issues
- npm.io page: https://npm.io/package/grunt-gandi-deploy

## Dependencies (2)

- [async](https://npm.io/package/async.md) ^2.0.0-rc.2
- [simple-ssh](https://npm.io/package/simple-ssh.md) ^0.8.9

## Recent versions

- 0.1.2 (latest) — 2016-04-01
- 0.1.1 — 2016-04-01
- 0.1.0 — 2016-04-01

## README

# grunt-gandi-deploy

> Help deploying apps on Gandi Simple Hosting using Git.

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

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-gandi-deploy --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-gandi-deploy');
```

## The "gandi_deploy" task

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

```js
grunt.initConfig({
  gandi_deploy: {
    your_target: {
        options: {
          login: 'your_gandi_login',
          ssh_key_path: '/path/to/rsa/private/key',
        },
        src: 'path/to/deploy/directory'
    },
  },
});
```

### Options

#### options.login
Type: `String`

Your Simple Hosting instance admin login

#### options.ssh_key_path
Type: `String`

Path to your SSH private key. This method is strongly recommended.

#### options.password
Type: `String`

Password for your instance. This option is not recommended. Use SSH Key instead.

#### options.vhost
Type: `String`
Default value: `'default'`

Vhost to deploy to. (Only `'default' on Node.js, Python or Ruby instances)

#### options.datacenter_location
Type: `String``
Default value: `'dc0'`

Your SimpleHosting instance datacenter location

#### options.branch
Type: `String`
Default value: `'master'`

Branch to deploy to.

#### options.message
Type: `String`
Default value: `'autocommit'`

Commit message

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

Tag for the release. The release is not tagged if value is `false`

#### options.tag_message
Type: `String`
Default value: `'autocommit'`

Message for the tag. Ignored if options.tag is `false`

#### options.git_clean
Type: `String`
Default value: `false`

Whether to execute à `git clean` operation on the vhost directory see [Gandi Documentation](https://wiki.gandi.net/en/simple/git) for details

#### options.remote
Type: `String`
Default value: `'origin'`

Git remote name.

#### options.tmp_dir
Type: `String`
Default value: `'tmp'`

Plugin's working directory name. `'tmp'` is the default value but can be changed if needed.


## Notes
There are no unit tests for this plugin yet. Use it carefully.

For more informations about Simple Hosting Git access, see [Gandi Documentation](https://wiki.gandi.net/en/simple/git)

This plugin is not written or supported by [Gandi](https://www.gandi.net/).

This plugin has been inspired by [grunt-git-deploy](https://github.com/iclanzan/grunt-git-deploy) and uses some of its code.

## Contributing
Every contribution is welcome !

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