README

This repository contains scripts used in the Eelzee CircleCI build process. The scripts are meant to execute in a customized CircleCI Docker container.

Prerequisites:

The most recent version of this script executes an OAuth2 request against Bitbucket to retrieve information about the current pull request being executing. In order to retrieve this information, a CircleCI context has been established named 'eelzeedev-global' that contains credentials for the request. You should add a "workflows" section to your config.yml file to include this context and gain access to these variables. See example_config.yml for an example of this declaration (at the bottom).

The variables BITBUCKET_CLIENT_KEY and BITBUCKET_CLIENT_SECRET are declared externally. These variables are used to authenticate (via OAuth) to Bitbucket during processing. Speak with Eelzee staff if you need to learn more about these variables.

Usage:

Note: If CircleCI has never before been run for this project, you may need to initialize it by choosing "Set up project" for the repo in question at https://circleci.com/add-projects/bb/eelzeedev.

To set up a project to use Version 2 of the CircleCI automation and our build scripts:

Add a CircleCI configuration file to the repo, and a variables file.

• Create a .circleci folder in your project root.
• Copy the contents of example_config.yml in this repo to .circleci/config.yml in your repo, and update as appropriate for your project.
  • Defaults work fine in most cases. Pay attention to the image being used. You should be choosing a valid php 5.6 or 7.1 eelzee circle-ci repo image from those listed here.
• Copy the contents of example_script_variables.yml to .circleci/script_variables.yml in your repo, and update as appropriate for your project.

Additional info:

• See also the associated DockerHub Images.
• See also the eelzee build scripts Packagist Entry.
• It is often useful to test builds locally before pushing to the remote repository. You may use the CircleCI cli tool to test a local build. Not all variables are defined for local builds, but you may supply values for theme here if you need them. Note that setup and usage of that tool is not necessary to use CircleCI, so documentation for doing so is not included here.