Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 4.68 KB

README.md

File metadata and controls

94 lines (64 loc) · 4.68 KB
Raw

Scatter

A deploy helper.

Installation

gem install scatter_deploy

If your Gem directory is in your PATH, you'll now have access to the scatter command. Run scatter help for an overview.

Scatter requires Ruby >= 1.9.2.

Usage

You interact with Scatter through the scatter command. You can see a basic overview with scatter help.

Tasks:
  scatter alias FROM, TO         # Create an aliased Scatter command
  scatter cap COMMAND            # Run arbitrary Capistrano commands.
  scatter config SETTING, VALUE  # Set a default config option in ~/.scatterconfig
  scatter deploy                 # Run a deploy routine. This is the default task.
  scatter exec COMMAND           # Run arbitrary commands.
  scatter help [TASK]            # Describe available tasks or one specific task
  scatter version                # Show version.

Options:
  -d, [--directory=DIRECTORY]  # Specify a deploys directory.
                               # Default: /Users/evan/.deploys
  -p, [--project=PROJECT]      # Specify a project path, defaults to current Git repository root.
  -s, [--shared=SHARED]        # Use a deploy script in the __shared directory. The project path will automatically be passed as an argument
      [--dry-run]              # Print 'success' if the command would have succeeded, otherwise an error message, without actually running the command.

All commands take three optional flags, --directory, --project, and --shared.

Flags

  • --directory, -d: Specify the root of your deploys directory. Defaults to ~/.deploys.
  • --project, -p: Specify a path to a project (relative or absolute). Defaults to the root of the current Git repository, if one exists. If you're not in a Git repository you must pass this argument.
  • --shared, -s: Specify a shared deploy command to use instead of a project-specific script. The absolute project path will be passed as an argument to the command.
  • --dry-run: Determine whether or not the command would succeed, without actually running it. Prints 'success' for commands that could run, otherwise an appropriate error. Successes will exit with a 0 error code, failures with 1. Note: This flag is only used for deploy commands (deploy, cap, and exec), it's ignored for other commands (version, config, alias).

Commands

scatter or scatter deploy

Scatter's default task is deploy, so running scatter deploy is exactly the same as running scatter. The deploy command will look first for an executable file called deploy in the project-specific deploy directory, then for a Capfile. If it finds an executable, it will run it. If no executable is found, but a Capfile is found, it will run cap deploy.

scatter cap COMMAND

Let's you run arbitrary Capistrano commands, e.g. scatter cap nginx:restart. All commands will be proxied to the project-specific deploy directory, which must contain a Capfile and config.

scatter exec COMMAND

Let's you run arbitrary shell commands in the project-specific deploy directory, e.g. scatter exec ls.

Config

You can set default configuration options in ~/.scatterconfig using YAML. Currently used settings are:

  • directory (string): Sets your default deploys directory, acts like using the --directory flag without having to specify it each time.
  • aliases (array): Aliases Scatter commands to other Scatter commands. For example, you could alias scatter foo to scatter -p ~/code/foo -d ~/.foodeploys. Aliases will always prepend scatter to the aliased command.

Scatter exposes config and alias commands to manage these settings. You can also manually edit ~/.scatterconfig. Here's an example config file:

---
directory: /Users/evan/code/mydeploys
aliases:
  wp: -s wp
  rgem: -s gem
  foo: -p ~/code/foo -d ~/code/foodeploys

These settings could be achieved with these commands:

scatter config directory ~/code/mydeploys
scatter alias wp "-s wp"
scatter alias gem "-s gem"
scatter alias foo "-p ~/code/foo -d ~/code/foodeploys"

Examples

  • scatter: Deploy the current project.
  • scatter -p projectname: Deploy the project in ./projectname.
  • scatter -p ~/projectname: Deploy the project in your home directory's projectname directory.
  • scatter -s wp: Deploy the current project by calling ~/.deploys/__shared/wp and passing your current Git repository's root as an argument.

WordPress

One of my use cases for Scatter is deploying WordPress plugins versioned with Git to WordPress.org, which uses Subversion. I wrote a post on how I use Scatter to do it: Git, WordPress plugins, and a bit of sanity: Scatter.