theme-juice 0.26.3 → 0.27.0

data/lib/theme-juice/man/tj-deploy.txt

@@ -21,8 +21,8 @@ SETUP
 
        1.  Create a deploy user on the stage server
 
-       2.  Set	up  SSH keys for the new deploy user to SSH in without a pass-
-	   word
+       2.  Set	up  SSH  keys  for  the  new deploy user for password-less SSH
+	   access
 
        3.  Confirm the deploy user owns the deploy path
 
@@ -98,9 +98,8 @@ SECONDARY COMMANDS
 
 CONFIG FILE
        The YAML Juicefile(5)  configuration  may  be  used  to	store  deploy-
-       ment-related  settings. Below you will find the various block sequences
-       you may use to define your project's deployment settings. All of  these
-       will be passed to capistrano(1) to invoke a deployment.
+       ment-related  settings. Below you will find the various options you can
+       use to define your project's deployment setup.
 
        deployment
 	      Deployment configuration
@@ -119,14 +118,15 @@ CONFIG FILE
 	      rsync_<setting> during the deployment initialization
 
        deployment.slack
-	      Optional settings passed to  capistrano-slackify(1);  mapped  as
+	      Optional	settings  passed  to capistrano-slackify(1); mapped as
 	      slack_<setting> during the deployment initialization
 
        deployment.stages
 	      Deployment stages
 
        deployment.stages.<stage>.server
-	      Domain or IP address of the server
+	      Domain or IP address of the server; can include an optional port
+	      number in the form of <ip_or_domain>:<port>
 
        deployment.stages.<stage>.path
 	      Root path to the deployment directory
@@ -182,7 +182,134 @@ CONFIG FILE
        deployment.stages.vagrant.roles
 	      Sequence of roles for the development environment
 
-
-
-
-				 January 2016			  TJ-DEPLOY(1)
+       Below is an example deployment configuration:
+
+
+
+	     # Project configuration
+	     project:
+	       name: example
+
+	     # Deployment configuration
+	     deployment:
+
+	       # Repository settings
+	       repository:
+		 repo_url: git@github.com:example/example-app.git
+		 branch: :master
+		 scm: :rsync
+
+	       # Other settings that will be passed directly to Capistrano
+	       # @see http://capistranorb.com/
+	       settings:
+		 keep_releases: 5
+		 format: :pretty
+		 log_level: :verbose
+		 use_sudo: false
+		 ssh_options:
+		   keys: ~/.ssh/id_rsa
+		   forward_agent: true
+		   paranoid: true
+		 # Add additional directories to $PATH. This is useful if you're
+		 #  on a shared hosting environment (i.e. GoDaddy) and you need
+		 #  to use an executable such as wp-cli for database migration.
+		 default_env:
+		   path: /opt/wp-cli/bin:$PATH
+
+	       # Capistrano rsync options and install procedure
+	       # @see https://github.com/Bladrak/capistrano-rsync
+	       rsync:
+		 stage: tmp/deploy
+		 cache: shared/deploy
+		 scm: :git
+		 depth: 1
+		 # Options to pass to the rsync command
+		 # @see http://linux.die.net/man/1/rsync
+		 options:
+		   - --recursive
+		   - --delete
+		   - --delete-excluded
+		   - --include="vendor/**/*" # Overrides any excluded patterns
+		   - --exclude="node_modules/"
+		   - --exclude=".env.sample"
+		   - --exclude=".git*"
+		   - --exclude="Juicefile*"
+		   - --exclude="composer.*"
+		   - --exclude="package.json"
+		   - --exclude="README.*"
+		 # Run application install scripts
+		 install:
+		   - composer install --no-dev
+		   - bundle install
+		   - npm install
+		   - bower install
+		   - grunt build
+		 # Run scripts before the deployment starts
+		 pre_scripts:
+		   - touch .maintenance
+		 # Run scripts before the deployment finishes
+		 post_scripts:
+		   - rm .maintenance
+		   - sudo service apache2 restart
+
+	       # Slack integration
+	       # @see https://github.com/onthebeach/capistrano-slackify
+	       slack:
+		 url: https://hooks.slack.com/services/your-token
+		 username: Deploybot
+		 channel: "#devops"
+		 emoji: ":rocket:"
+
+	       # Deployment stages
+	       stages:
+
+		 production:
+		   server: 192.168.13.37:1234
+		   path: /var/www/production
+		   user: deploy
+		   url: example.com
+		   uploads: app/uploads
+		   tmp: tmp
+		   shared:
+		     - .env.production
+		   ignore:
+		     - robots.txt
+		   roles:
+		     - :web
+		     - :app
+		     - :db
+
+		 staging:
+		   server: 192.168.13.37
+		   path: /var/www/staging
+		   user: deploy
+		   url: staging.example.com
+		   uploads: app/uploads
+		   tmp: tmp
+		   shared:
+		     - .env.staging
+		   roles:
+		     - :web
+		     - :app
+		     - :db
+
+		 # This is your development environment used to push/pull database files,
+		 #  uploads, the .env file, etc.
+		 vagrant:
+		   server: example.dev
+		   path: /srv/www/tj-example
+		   user: vagrant
+		   pass: vagrant
+		   url: example.dev
+		   uploads: app/uploads
+		   backup: backup
+		   tmp: tmp
+		   roles:
+		     - :dev
+
+
+
+
+
+
+				  August 2016			  TJ-DEPLOY(1)

data/lib/theme-juice/man/tj-init

@@ -15,6 +15,6 @@ Initializes the virtual machine\.
 .SH "GLOBAL OPTIONS"
 .
 .TP
-\fB\-\-provision\fR
+\fB\-\-vm\-provision\fR, \fB\-\-provision\-vm\fR, \fB\-\-provision\fR
 Run provisioners after initializing the virtual machine
 

data/lib/theme-juice/man/tj-init.txt

@@ -12,7 +12,7 @@ DESCRIPTION
        Initializes the virtual machine.
 
 GLOBAL OPTIONS
-       --provision
+       --vm-provision, --provision-vm, --provision
 	      Run provisioners after initializing the virtual machine
 
 

data/lib/theme-juice/man/tj-setup

@@ -73,8 +73,4 @@ Modify \fBwp\-config\.php\fR file contents with project configuration (this flag
 .TP
 \fB\-\-no\-ssl\fR, \fB\-\-no\-https\fR
 Project does not need SSL support
-.
-.TP
-\fB\-\-provision\fR
-Run provisioners after setting up project
 

data/lib/theme-juice/man/tj-setup.txt

@@ -60,9 +60,6 @@ GLOBAL OPTIONS
        --no-ssl, --no-https
 	      Project does not need SSL support
 
-       --provision
-	      Run provisioners after setting up project
-
 
 
 

data/lib/theme-juice/man/tj.txt

@@ -112,86 +112,170 @@ SECONDARY COMMANDS
 	      proxied to your Vagrant installation so that  they  can  be  run
 	      from any directory.
 
+CONFIG FILE
+       A  YAML	configuration  file called a Juicefile(5) can be used to store
+       commonly used build scripts, similar to npm(1)  scripts.  Each  command
+       can  be	mapped	to any build script you like, allowing you to define a
+       set of commands that can be used across all of your  projects.  If  you
+       plan  to deploy using tj, this file will also house your deploy(1) con-
+       figuration.
+
+       For reference, below is an example config:
+
+
+
+	     # Project configuration
+	     project:
+	       name: example
+	       url: example.dev
+
+	     # Manage command aliases for the current project
+	     commands:
+
+	       # Run project install scripts
+	       install:
+		 - npm install
+		 - grunt build
+
+	       # Manage build tools
+	       dev:
+		 - grunt %args%
+
+	       # Manage front-end dependencies
+	       assets:
+		 - npm %args%
+
+	       # Manage back-end dependencies
+	       vendor:
+		 - composer %args%
+
+	       # Create a backup of the current database with a nice timestamp
+	       backup:
+		 - mkdir -p backup
+		 - wp @dev db export backup/$(date +'%Y-%m-%d-%H-%M-%S').sql
+
+	     # Manage deployment settings for the current project
+	     deployment:
+	       # ...
+
+	       stages:
+		 # ...
+
+
+
 CONFIG COMMANDS
-       These  run  the	corresponding command from your project's config file.
-       They accept any number of arguments, since the behavior and handling of
-       input  is defined within the config file itself. Below are the commands
-       defined within the Theme Juice starter template.
+       The commands within the commands block can be run from the command line
+       via tj <command>. For example, we can run the dev command by running tj
+       dev, which will in turn run the command grunt.
 
-       install=[arg[,arg]...]
-	      Run installation for project
+       If you noticed in the example above, there are a few commands that con-
+       tain  %args%;  each  command  list is run within a single execution via
+       joining: cmd1 &&  cmd2  [&&  cmd3...],  with  all  %args%/%argN%  being
+       replaced with the corresponding argument index, when available.
 
-       watch=[arg[,arg]...]
-	      Manage and run development build tools
+       Here's a few example commands using placeholders:
 
-       assets=[arg[,arg]...]
-	      Manage front-end dependencies for project
 
-       vendor=[arg[,arg]...]
-	      Manage back-end dependencies for project
 
-       dist=[arg[,arg]...]
-	      Package project for distribution
+	     example-command:
+	       # Will contain all arguments joined by a space
+	       - cmd1 %args%
+	       # Will contain each argument mapped to its respective index
+	       - cmd2 '%arg1% %arg2% %arg3%'
+	       # Will only map argument 4, while ignoring 1-3
+	       - cmd3 "%arg4%"
 
-       wp=[arg[,arg]...]
-	      Manage project's wordpress(7) installation with wp-cli(1)
 
-       backup=[arg[,arg]...]
-	      Backup project
 
-       test=[arg[,arg]...]
-	      Manage and run project tests
+       To  clarify a little bit more, we could run tj dev build, and since our
+       dev command contains %args%, that will in turn run  the	command  grunt
+       build;  if we run tj dev some:other task, that would be interpreted and
+       run as grunt some:other task.
 
-CONFIG FILE
-       A YAML Juicefile(5) configuration can be used  to  store  commonly-used
-       build  scripts  (and  deploy(1)	info), similar to npm(1) scripts. Each
-       command block sequence can be mapped to an individual  project's  build
-       tool, allowing a streamlined set of commands to be used across multiple
-       projects that utilize different tools. Below are descriptions  for  the
-       default commands within the Theme Juice starter template's Juicefile.
+       You can specify an unlimited number of commands with an unlimited  num-
+       ber  of arguments within your Juicefile; however, you should be careful
+       with how this is used. Don't go including sudo rm -rf %arg1% in a  com-
+       mand,  while  passing / as an argument. Keep it simple. These are meant
+       to make your life easier by helping you manage build tools, not	to  do
+       fancy scripting.
+
+CONFIG TEMPLATE STRINGS
+       You may define ERB template strings within a project starter template's
+       Juicefile(5). These will be replaced upon running create(1).
+
+       For example,
+
+
+
+	     # Project configuration
+	     project:
+	       name: <%= name %>
+	       url: <%= url %>
+
+
+
+       will be replaced with,
+
+
+
+	     # Project configuration
+	     project:
+	       name: example-project
+	       url: example-project.dev
+
+
+
+       if those were the options chosen during a creation. The following vari-
+       ables are available for use:
+
+       name   Project name
+
+       location
+	      Project location
+
+       url    Project URL
+
+       xip_url
+	      Project xip.io URL
 
-       commands
-	      Collection of various command block sequences
+       template
+	      Project template repository URL
 
-       commands.install
-	      Command sequence used to properly install and build project
+       repository
+	      Initialized repository URL, if available
 
-       commands.watch
-	      Command used to manage development build tools
+       db_host
+	      Project database host
 
-       commands.assets
-	      Command used to manage front-end dependencies
+       db_name
+	      Project database name
 
-       commands.vendor
-	      Command used to manage back-end dependencies
+       db_user
+	      Project database user
 
-       commands.wp
-	      Command used to manage WordPress installation
+       db_pass
+	      Project database password
 
-       commands.dist
-	      Commands used to package project for distribution
+       db_import
+	      Path to imported database file
 
-       commands.backup
-	      Commands used to backup project
+       vm_box Virtual machine box URL
 
-       commands.test
-	      Command used to manage and run project tests
+       vm_ip  Virtual machine IP address
 
-       Placeholder  arguments can be used within any command block sequence to
-       allow splat or indexed arguments to be passed to the corresponding com-
-       mand when executed.
+       vm_path
+	      Virtual machine location on the host machine
 
-       %args%, %arguments%
-	      Splat argument placeholder e.g. cmd %args%
+       vm_root
+	      Web root of the VM on the host machine
 
-       %argN%, %argumentN%
-	      Where n is the argument index e.g. cmd %arg1% | cmd %arg2%
+       vm_location
+	      Project location within the VM on the host machine
 
-       When  naming your configuration file, use the recommended Juicefile, or
-       .tj.yaml naming convention. The raw filename regex matcher is below  if
-       you want to be a little different.
+       vm_srv Project location within the VM on the guest machine
 
-       /^(((\.)?(tj)|((J|j)uicefile))(\.y(a)?ml)?$)/
+       vm_prefix
+	      Virtual machine project location prefix
 
 ENVIRONMENT
        All of the global options have a corresponding ENV variable that can be
@@ -251,4 +335,4 @@ ENVIRONMENT
 
 
 
-				   July 2016				 TJ(1)
+				  August 2016				 TJ(1)

data/lib/theme-juice/project.rb

@@ -13,6 +13,7 @@ module ThemeJuice
     attr_accessor :vm_location
     attr_accessor :vm_srv
     attr_accessor :vm_restart
+    attr_accessor :vm_provision
     attr_accessor :repository
     attr_accessor :db_host
     attr_accessor :db_name
@@ -31,7 +32,6 @@ module ThemeJuice
     attr_accessor :no_ssl
     attr_accessor :no_config
     attr_accessor :wp_config_modify
-    attr_accessor :provision
 
     def vm_root
       @vm_root ||= File.expand_path("#{Env.vm_path}/www")