Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominicrico/grunt-vagrantup
Manages starting up and shutting down your Vagrant boxes as part of your Grunt development and testing workflow.
https://github.com/dominicrico/grunt-vagrantup
Last synced: about 7 hours ago
JSON representation
Manages starting up and shutting down your Vagrant boxes as part of your Grunt development and testing workflow.
- Host: GitHub
- URL: https://github.com/dominicrico/grunt-vagrantup
- Owner: dominicrico
- License: mit
- Created: 2016-01-27T16:03:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2014-09-28T17:12:05.000Z (about 10 years ago)
- Last Synced: 2023-02-28T21:32:39.373Z (over 1 year ago)
- Language: JavaScript
- Size: 152 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-vagrantup
> Manages starting up and shutting down your Vagrant boxes as part of your Grunt development and testing workflow.
## 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-vagrantup --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-vagrantup');
```
## Notes
This task does not install or configure Vagrant for you, it merely aids in spinning up and shutting down your Vagrant boxes on demand. For installation and configuration of Vagrant, see https://www.vagrantup.com.
## Tasks
`vagrantup` is intended for use in two different modes:
* **Synchronous mode**, where the Vagrant box remains up only to support other Grunt tasks and is shut down once those tasks have completed.
* **Keepalive mode**, where the Vagrant box remains up indefinitely until the task process is cancelled.
### Synchronous mode
This is the default mode for `vagrantup`. It is designed to support a workflow where a Vagrant box needs to be set up for automated testing and then disposed of. The task configuration can optionally include a list of `setup` tasks and a list of `teardown` tasks. The `setup` tasks will be run after the Vagrant box has started up, and the `teardown` tasks will be run before the box is shut down:
```js
vagrantup: {
testing: {
options: {
// Run your production build routine, copy the files to a directory shared with Vagrant...
setup: ['setupTaskOne', 'setupTaskTwo:target'],
// Clean out the shared directory...
teardown: ['teardownTask']
}
}
}
```
In order to provide full control over the Vagrant lifecycle, `vagrantup` also exports a task called `vagranthalt`. This task takes no target, and does not need to be added to the Grunt configuration. It should be invoked after the `vagrantup` task, once the Vagrant box is no longer needed:
```js
grunt.registerMultiTask('testWithVagrant', ['vagrantup:testing', 'runTests', 'vagranthalt']);
```
### Keepalive Mode
If the `keepalive` option is set to `true`, the `vagrantup` task will keep the Vagrant box up until the task process is explicitly killed by the user. This mode is designed to support a workflow where the Vagrant environment is used for active development. The task configuration accepts the same options as Synchronous Mode:
```js
vagrantup: {
development: {
options: {
keepalive: true,
// Set up your development environment, symlink the files to a directory shared with Vagrant...
setup: ['setupTaskThree', 'setupTaskFour:target'],
// Clean out the shared directory...
teardown: ['teardownTask']
}
}
}
```
In this mode, there is no need for the `vagranthalt` task, the tear down routine will run when the task process is killed. Setting up the development environment can be accomplised with `grunt vagrantup:development`.
Keepalive Mode can also be enabled ad-hoc with a flag: `grunt vagrantup:testing:keepalive`
Task-level options can be used to share configuration between Synchronous Mode targets and Keepalive Mode targets:
```js
vagrantup: {
options: {
// Clean out the shared directory...
teardown: ['teardownTask']
},
testing: {
options: {
// Run your production build routine, copy the files to a directory shared with Vagrant...
setup: ['setupTaskOne', 'setupTaskTwo:target']
}
},
development: {
options: {
keepalive: true,
// Set up your development environment, symlink the files to a directory shared with Vagrant...
setup: ['setupTaskThree', 'setupTaskFour:target']
}
}
}
```
## 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/).
## Release History
_(Nothing yet)_