Wildland DevTools

This is a gem that contains all of our dev rake tasks. These are most useful for projects created by trailhead and are deployed on heroku using the pipeline feature. This allows for separate staging and production enviroments as well as review apps.

Installation

  • Add the following to your Gemfile:

gem 'wildland_dev_tools', '~>1.0'

Typically for wildland projects you will want to put this inside the dev/test block:

group :development, :test do
  ...
  gem 'wildland_dev_tools', '~>1.0'
  ...
end
  • Run bundle install to install the gem.

Heroku Tasks require the following steps

  • Install the heroku CLI.
    • For OSx users you can do this using brew by running brew install heroku.
  • Ensure you have your production and staging git remotes set.
    • heroku git:remote -a <staging-app> -r staging where <staging-app> is your heroku staging app name.
    • heroku git:remote -a <production-app> -r production where <production-app> is your heroku production app name.

Common Install Fixes

  • If bundle install borks on pg_config then set the Pg_config path with bundle config build.pg --with-pg-config=/Applications/Postgres.app/Contents/Versions/{YOUR VERSION}/bin/pg_config

Usage

You will get a new batch of new rake tasks under the wildland namespace. For a full list run rake -T.

Common Development Tasks

  • rake wildland or rake wildland:setup This will run all of the setup tasks to get your local enviroment ready to go.
  • rake wildland:db This will resetup and seed the local database.
  • rake wildland:cache_clear This will clear the local app-ember package cache.

Code Quality Tasks

  • rake wildland:pre_pr or rake wildland:pre_pull_request This will run all pre-pull request checks.
  • rake wildland:pre_pull_request:fixme_notes Print only FIXME notes
  • rake wildland:pre_pull_request:html Run brakeman & rubocop with html formats and save them to /reports
  • rake wildland:pre_pull_request:js_debugger Find js debugger statements
  • rake wildland:pre_pull_request:notes Create a report on all notes
  • rake wildland:pre_pull_request:rubocop_recent Run rubocop against all created/changed ruby files
    • rake wildland:pre_pull_request:rubocop_recent[autocorrect] This perform the deploy as above, but have rubocop attempt to autocorrect issues.

Heroku Tasks

Deploying

  • rake wildland:heroku:deploy_to_staging This will deploy master to staging. This will automatically create a release candidate git tag.
    • rake wildland:heroku:deploy_to_staging[verbose] This perform the deploy as above, but in verbose mode.
    • rake wildland:heroku:deploy_to_staging[verbose,force] This perform the deploy as above, but this will --force deploy master to staging.
  • rake wildland:heroku:deploy_current_branch_to_staging This will promote your current branch to staging as master. This will NOT automatically create a release candidate git tag.
    • rake wildland:heroku:deploy_current_branch_to_staging[verbose] This perform the deploy as above, but in verbose mode.
    • rake wildland:heroku:deploy_current_branch_to_staging[verbose,force] This perform the deploy as above, but this will --force deploy your current branch to staging.
  • rake wildland:heroku:promote_to_production This will promote staging to production. This will automatically create a production git tag.
    • rake wildland:heroku:promote_to_production[verbose] This perform the deploy as above, but in verbose mode.

Utility

  • rake wildland:heroku:maintenance_mode_on This turns on maintenance mode for staging and production.
  • rake wildland:heroku:maintenance_mode_off This turns off maintenance mode for staging and production.
  • rake wildland:heroku:backup_production_database This will create a backup of the production database.
    • rake wildland:heroku:backup_production_database[verbose] This perform the deploy as above, but in verbose mode.
  • rake wildland:heroku:import_latest_production_database_backup This will import the latest production database backup to your local database.
    • rake wildland:heroku:import_latest_production_database_backup[verbose] This perform the deploy as above, but in verbose mode.

Code Of Conduct

Wildland Open Source Code Of Conduct