imagex/swat

A Robo CLI tool for ImageX Projects in Drupal 8+

6.1.0 2024-04-16 21:49 UTC

Requires

• ext-posix: *
• acquia/coding-standards: ^2.0
• acquia/drupal-recommended-settings: ^1.0
• consolidation/config: ^2.0
• consolidation/robo: ^4
• cweagans/composer-patches: ^1.7
• drush/drush: ^12.5 || 13
• php-parallel-lint/php-parallel-lint: ^1.4
• phpro/grumphp: ^2.5

MIT

• Bryan Sharpe

README

(SUPER WICKED AWESOME TOOL)

SWAT is meant to be a helper for projects within ImageX. It provides a docksal setup, some templated Bitbucket pipelines and deployment helpers. And it's super wicked awesome.

Requirements

SWAT requires the following to run:

1. Docksal - https://docksal.io/
2. Composer - https://getcomposer.org/
3. PHP >=8.1

Available Commands

Run fin swat list to get a listing of available commands.

GETTING STARTED

Note: it's a good idea to run fin upgrade before starting to be sure you have the latest stacks.

New projects must use Drupal 10.

1. fin project create --repo=[e-mail]:ixm/swat-project-template.git --name=<project_name>
2. Follow the prompts
3. cd <project-name>
4. Modify docksal.env for any stack changes
   1. Hardcode your PHP, DB, etc images to match your remote host
   2. If you've made changes, make sure to reset your stack!
5. Modify swat/swat.yml specific to project - see more details here
   1. Add Remote Git repo (Acquia, pantheon, etc)
   2. Add Remote Git user/email (see example below)
6. Download your remote drush aliases: Project Setup - Drush
7. (If docroot changed) Update your location in:
   1. phpcs.xml
   2. .tugboat/config.yml
8. fin swat install
9. Export your config.
10. Setup your git remote
    1. git remote add origin [e-mail]:example/example.git
    2. git add . && git commit -m "PROJ-1: Initial Setup for <project>."
    3. git push -u origin master

Hosting Provider

See our internal documentation: Configuring your hosting provider files

Git:

Example of Git config in swat.yml for remote:

    git:
      default_branch: develop
      remotes:
        cloud: '[e-mail]:ixmcomponents.git'
      user:
        name: 'ImageX Media'
        email: [e-mail]

Existing Projects

For existing projects you can still get hosting pipelines or docksal setup.

1. fin composer require imagex/swat

Available Commands

setup:existing

• This command runs both hosting and pipeline commands.

hosting

• Setup the defaults for a hosting/deployment.

bitbucket:pipelines

• Installs a default pipeline based on hosting

Troubleshoot

1. [e-mail]: Permission denied (publickey). on fin project create:
   1. Check if you have access on https://bitbucket.org/ixm/swat-project-template
   2. Run fin system start and try again
2. Project healthcheck has timed out on fin project create:
   1. Run the following commands:

      fin start
      fin init