generoi/robo-genero

Genero tasks for Robo Task Runner

v0.5.0 2024-11-12 14:17 UTC

Requires

• php: >=7.2
• consolidation/robo: ~1|~2|~3|~4|~5
• dflydev/dot-access-data: ^1|^3
• symfony/filesystem: ^2.5|^3|^4|^5|^6|^7
• symfony/finder: ^2.5|^3|^4|^5|^6|^7
• symfony/process: ^5|^6|^7
• symfony/yaml: ^2.8.11|^3|^4|^5|^6|^7

Requires (Dev)

• squizlabs/php_codesniffer: ^3.0

MIT

• Oskar Schöldström

• robo

README

Genero tasks for Robo Task Runner

Installation

Require robo and this package to your project.

composer require consolidation/robo generoi/robo-genero

Composer scripts

Add the following scripts section to your composer.json

  "scripts": {
    "post-create-project-cmd": [
      "Generoi\\Robo\\Composer\\ComposerScript::postCreateProject"
    ],
    "test": [
      "Generoi\\Robo\\Composer\\ComposerScript::test"
    ]
  }

RoboFile.php

Add a RoboFile.php, you can check Genero's Bedrock repository for an example.

<?php

use Robo\Robo;
use Generoi\Robo\Task\loadTasks;
use Generoi\Robo\Command\loadCommands;

class RoboFile extends \Robo\Tasks
{
    use loadTasks;
    use loadCommands;

    /**
     * Pull uploads directory from remote to local.
     *
     * @param  string  $source  Source alias eg. `production`
     * @return \Robo\Result
     */
    public function filesPull(string $source, $options = ['exclude' => null, 'dry-run' => false])
    {
        return $this->rsyncPull("{$source}:%files", $options);
    }

    /**
     * Push uploads directory from local to remote.
     *
     * @param  string  $destination  Destination alias eg. `production`
     * @return \Robo\Result
     */
    public function filesPush(string $destination, $options = ['exclude' => null, 'dry-run' => true])
    {
        return $this->rsyncPush("{$destination}:%files", $options);
    }
}

robo.yml

Create a robo.yml file:

machine_name: <example-project>
theme_path: 'web/app/themes/${machine_name}'
organization: generoi
env:
  '@docker':
    host: '${machine_name}.ddev.local'
    wpcli: 'ddev exec wp-cli'
    path: '/var/www/html'
    url: 'http://${machine_name}.ddev.local'
  '@dev':
    host: '${machine_name}.test'
    user: vagrant
    path: '/var/www/wordpress'
    url: 'http://${machine_name}.test'
  '@staging':
    host: staging.example.org
    user: deploy
    path: '/var/www/staging/${machine_name}/deploy/current'
    ssh: 'ssh -o ForwardAgent=yes'
    url: 'http://staging.example.org'
  '@production':
    host: production.example.org
    user: deploy
    path: '/home/www/${machine_name}/deploy/current'
    ssh: 'ssh -o ForwardAgent=yes -o "ProxyCommand ssh [e-mail] nc %h %p 2> /dev/null"'
    url: 'https://production.example.org'

placeholders:
  '%files': web/app/uploads/

command:
  build:
    production:
      options:
        npm-script: 'build:production'
    development:
      options:
        npm-script: 'build'
  setup:
    theme:
      options:
        theme-repository: '[e-mail]:generoi/sage.git'
  search:
    replace:
      options:
        dirs:
          - config
          - web/app/themes
          - web/app/mu-plugins
        exclude:
          - robo.yml
          - dist
  db:
    options:
      exclude_tables:
        - wp_gf_entry
        - wp_gf_entry_meta
        - wp_gf_entry_notes
        - wp_gf_incomplete_submissions
        - wp_rg_incomplete_submissions
        - wp_rg_lead
        - wp_rg_lead_detail
        - wp_rg_lead_detail_long
        - wp_rg_lead_meta
        - wp_rg_lead_notes
        - wp_stream
        - wp_stream_meta
    pull:
      options:
        target: '@dev'
    push:
      options:
        source: '@dev'
  files:
    options:
      options:
        chmod: 'Dug=rwx,Do=rx,Fug=rw,Fo=r'
      exclude:
        - 'gravity_forms/'
        - '*.webp'
        - '*-c-*.jpg'
        - '*-c-*.jpeg'
        - '*-c-*.png'

task:
  Remote:
    RsyncAlias:
      settings:
        progress: true
        humanReadable: true

Usage

robo list
robo build:production
robo rsync production:~/.bashrc .
robo rsync:pull production:%files
robo files:pull production
robo test:sniff --autofix
robo setup
robo search:replace