mtholyoke/jorge

MHC’s command-line tool for automating development tasks

Maintainers

Details

github.com/mtholyoke/jorge

Homepage

Source

Issues

Installs: 59

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 0

v0.6.9 2020-04-08 16:30 UTC

Requires

Requires (Dev)

MIT 9fda69210db130fda3350fa47dd818385aa929d9

climtholyoke

This package is auto-updated.

Last update: 2024-05-01 00:09:02 UTC

README

Jorge is an experimental command-line tool for managing the complex interaction of Drush, Git, Lando, and Terminus to automate common tasks.

Note: Jorge stores no connection information about the various services and does not provide any additional permission; your account must already have access (ideally via SSH key or token) to the various projects on GitHub and Pantheon, and Jorge works on your behalf using those credentials.

Installation

Recommended: Install with Composer/CGR

This is not a thing to require within a project; it’s a tool for your workstation. Composer facilitates that with composer global require, but that command is somewhat flawed in the way it manages things, so we prefer cgr.

To install cgr, run composer global require consolidation/cgr and it will be added in the .composer directory off your home directory. You will also need to tell the system that you’re adding executables to a new place. In your home directory, there can be a file named .bash_profile or .profile which is run every time you log in. Edit that file (create one if neither exists) and add a line at the end:

export PATH="$PATH:~/.composer/vendor/bin"

In order for the new PATH to take effect, you can either log out and back in, or run source .bash_profile (or source .profile). You can test that it worked by running cgr --help; it should give you help instead of an error message.

After all that, you should be able to run cgr mtholyoke/jorge:*. If it is successfully installed, jorge --version will report “Can’t find project root” and a version. You can omit the :* if you only want the current version with no major upgrades, or replace the * with a specific version.

For Development: Install with Git

You can also clone this repo for development and run Jorge directly from that copy. Rather than adding ~/Projects/jorge/bin (or whatever your Projects directory is; run pwd to check) to your path, I recommend making a symlink to bin/jorge (the actual program) from /usr/local/bin or some other location already in your path:

ln -s ~/Projects/jorge/bin/jorge /usr/local/bin/jorge

Run composer install in the Jorge directory to get its dependencies.

If you're going to do any development, also run bin/setup.sh once to install the standard Git hooks.

Configuration

Jorge has no global configuration; it works on the project level only.

The project’s root directory should contain a subdirectory .jorge, which should have a file config.yml. Samples are included in Jorge’s own .jorge directory.

In .jorge/config.yml, you must have the key appType. Currently, only drupal7, drupal8, and jorge are recognized as values.

Optionally, you may also have the key include_config, which specifies a list of additional configuration files to include from the .jorge directory, to be loaded in the order specified. Values in those files will override any previously loaded settings, including the main config.yml. Note that include_config is only allowed in the main config.yml file.

Drupal 7 or 8 Configuration

A config file may include the key reset, which contains a block that provides any of seven optional parameters to the reset command (described below):

  • auth - A Terminus machine token to authenticate with Pantheon for the reset
  • branch - Which Git branch to reset your current codebase to (default is master)
  • import - Whether to run drush config-import after pulling the database (default is FALSE)
  • content - Which Pantheon environment to copy database and files from (default is dev)
  • database - Which Pantheon environment to copy the database from (default matches content)
  • files - Which Pantheon environment to copy the files from (default matches database)
  • rsync - Whether Lando should use rsync to copy files (default is TRUE)
  • username - A username (usually an admin) that needs a local password (no default)
  • password - A local password for the username specified above (no default)

Commonly, the configuration committed to the project’s Git repo looks like this:

appType: drupal8
reset:
  branch: master
  content: dev
  rsync: TRUE
include_config:
  - local.yml

In local.yml, which is not committed to the project’s Git repo:

reset:
  auth: a1b2c3d4e5f6
  username: admin
  password: asdf1234

Commands

jorge drush {drush-command}

In a Composer-powered Drupal 8 project, lando drush {drush-command} may need to be run inside the web directory (so it has access to Drupal), regardless of whether you’re currently in that directory. This command lets you run it from outside that directory, (after starting Lando if it’s not already running).

It accepts the -y/--yes and -n/--no option natively, but other Drush options need to be escaped. See jorge help drush for details. Note that -n is actually Symfony --no-interaction, which has approximately the same effect.

jorge reset

Sets up the local development environment as specified in the configuration file(s) described above.

Note: Your project must be in a clean state: if Git can’t change branches, the whole thing will fail. Lando versions starting with 3.0.0-rc.2 (released 1 Feb 2019) require a Terminus machine token be present in the auth parameter (command line or config file); without this, the whole thing will fail.

Starts Lando if it is not already running, then uses lando pull to fetch the site from Pantheon.

Optionally takes command-line switches which will override the settings described above (except rsync); see jorge help reset for details.

If you are resetting to a branch other than master (using -b), you may need to also use -i if the branch has config different from the database to be pulled.

If an admin account username is provided but no password is supplied, Jorge will prompt you for one. If you leave that blank also, the password will not be reset.

Not Implemented Yet

jorge save – Save the current state of the code, database, and files so that it can be restored by a later reset.

Future Work

  • Make sure Drush is installed and working before relying on it.

  • More tests (see also Symfony doc Testing Commands)

    • Tool::exec() uses the Symfony Process component when user interaction is required, and a first pass at testing by executing read with -p "\nPress enter" x did not provide the expected coverage. Possibly we need to do a full mock as in ResetCommandTest::testInteract() and adjust Tool::exec() to use an InputInterface instead of STDIN.

  • Lando 3.0.0-rc.2 and later have an interactive auth system for commands that require it (such as lando pull, which is the heart of jorge reset). It would be nice to be able to pass this through to the user if they don’t have the token in their local.yml config file. These versions of Lando can also read the environment variable TERMINUS_TOKEN, so we should also check for that.

  • Implement Tools for Git, &c., using APIs or as service(s) within the container(s), for better awareness of initial/current state

  • Lando may not be a Tool; it may be a new kind of thing. Possibly we need a plugin interface for “environment manager”.

  • Option to stash or discard changes before a git checkout?

  • Implement jorge save and refactor jorge reset to be able to use saved state

  • Is it possible to check for Sass watcher (or similar idea) and suspend during Git operations?