andock-ci-build (A drupal docksal build script.)

andock-ci-build is a Ansible role which:

• Checks out a php repository (e.g. from github)
• Runs build tasks (like composer, npm etc.).
• Pushes all build artifacts to a target build repository (can be a different one like Acquia or the same. Andock CI pushes to {{ branch }}-build branch.)

Requirements

In order to build your apps with Andock CI, you will need:

• Ansible in your deploy machine
• build tools like composer or something else
• git on both machines

Role Variables

vars:
  git_source_repository_path: [email protected]:andock-ci/drupal-8-demo.git # The source repository 
  git_target_repository_path: [email protected]:andock-ci/drupal-8-demo-build.git # The target repository. Can be the same repository as the source repository 
  build_path: ~/ansible # The path where the build happens
  branch: "master" # The source branch. The target branch would be master-build
  hook_build_tasks: "hooks/build_tasks.yml" # The path to your build_tasks hook file

Installation

Andock-CI is an Ansible role distributed globally using Ansible Galaxy. In order to install Andock-CI role you can use the following command.

$ ansible-galaxy install andock-ci.andock-ci-build

Update

If you want to update the role, you need to pass --force parameter when installing. Please, check the following command:

$ ansible-galaxy install --force andock-ci.andock-ci-build

Dependencies

@TODO

Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

- name: Deploy repository to build repository
  hosts: localhost
  remote_user: cw
  roles:
    - role: andock-ci-build
      git_source_repository_path: [email protected]:andock-ci/drupal-8-demo.git
      git_target_repository_path: [email protected]:andock-ci/drupal-8-demo-build.git
      build_path: ~/ansible
      branch: "master"
      hook_build_tasks: "hooks/build_tasks.yml"

Handling .gitignore

You can mark parts in your .gitignore files with "BEGIN REMOVE ANDOCK-CI" --- END REMOVE ANDOCK-CI. andock-ci will remove that blocks before it will be commited to target repository

    #Sample .gitignore file for a drupal 8 composer project
    .idea
    
    #### BEGIN REMOVE ANDOCK-CI ###
    docroot/core
    docroot/modules/contrib
    docroot/themes/contrib
    docroot/profiles/contrib
    vendor
    #### END REMOVE ANDOCK-CI ###

build hooks under .ansible/hooks/build.yml

- name: composer install
  command: fin rc -T composer install
  args:
    chdir: "{{ build_path }}"

License

BSD

Author Information

Christian Wiedemann ([email protected])