A general purpose docker image for execution by Github Task Manager agents using the Docker Executor. Tools such as nodejs, maven, java, gradle and sonar-scanner are baked in.
To execute standalone adhoc builds and test runs, driven by environment variables passed in from GTM Agents servicing pull request hooks, without the overhead of managing external CI jobs.
The Github Task Manager Docker executor can pull a docker image, and run it with a set of environment vars and an adhoc command. This docker image incorporates a number of common tools that are useful for build and test executions.
The image is intended to be used by Github Task Manager, meaning no direct install is required.
Follow the guide here for implementation steps using the zotoio/gtm-worker docker image.
To run it locally for experimentation, create a .env file base on .envSample and:
docker run -it --env-file .env --net=host zotoio/gtm-worker /bin/bash
..then use the scripts in the /usr/workspace directory.
For sonarqube support, install and configure the official docker image:
docker run -d --name sonarqube -p 9000:9000 -p 9092:9092 sonarqube
| Environment variable | description |
|---|---|
| SONAR_HOST_URL | eg. http://localhost:9000 |
| SONAR_LOGIN | access token from SonarQube |
| SONAR_PROJECTNAME_PREFIX | prefix to append for display in sonarqube - not used for pull requests |
| SONAR_SOURCES | default is 'src' which is in the default checkout location |
| SONAR_JAVA_BINARIES | default is 'target' which is in the default checkout location |
| SONAR_MODULES | optional comma separated list of modules. sonar will look for source and target within each |
| SONAR_GITHUB_REPOSITORY | git org/repo eg. zotoio/gtm-agent |
| SONAR_ANALYSIS_MODE | 'preview' used for pull requests |
| SONAR_GITHUB_OAUTH | github personal access token |
| SONAR_KEEP_PROJECT_PROPERTIES | If not true, delete any sonar-project.properties files in repo |
| GIT_CLONE | git clone uri eg, https://github.com/org/repo.git |
| GIT_PR_BRANCHNAME | branch name from PR event |
| GIT_PR_ID | pull request number from PR event |
| BUILD_TYPE | nodejs or maven or gradle |
| BUILD_COMMAND | custom build command rather than derived from build type |
| S3_DEPENDENCY_BUCKET | bucket name to cache node_modules etc |
| GTM_AWS_REGION | aws region env var if not using IAM instance role |
| GTM_AWS_ACCESS_KEY_ID | aws access key env var if not using IAM instance role |
| GTM_AWS_SECRET_ACCESS_KEY | aws secret env var if not using IAM instance role |
| IAM_ENABLED | 'true' to use ec2 instance profile |
| AWS_S3_PROXY | proxy used to call s3 api |
| SLS_AWS_STAGE | serverless executor stage |
| SLS_AWS_REGION | serverless executor region |
| SLS_CUSTOM_DOMAIN | custom apigw domain |
| SLS_DEPLOY_MODE | parallel or sequential deploy of multiple lambda packages |
| SLS_APIGW_ENDPOINT_TYPE | EDGE, REGIONAL, or PRIVATE for private vpc endpoint |
| SLS_AWS_EXECUTION_ROLE | role arn for lambda execution |
| SLS_DEPLOYMENT_S3_BUCKET_PREFIX | use a shared bucket prefix for central serverless mgmt |
| SLS_HTTP_PROXY | https_proxy env var for sls build |
| SLS_NO_PROXY | no_proxy env var for sls build |
| SLS_VPC_ID | optional vpc id for serverless deployments |
| SLS_VPC_SECURITY_GROUP_ID | optional security group id for serverless deployments |
| SLS_VPC_SUBNET_A | optional subnet id for serverless deployments |
| SLS_VPC_SUBNET_B | optional subnet id for serverless deployments |
| SLS_VPC_SUBNET_C | optional subnet id for serverless deployments |
| SLS_AWS_KMS_KEY_ID | kms key for sls encrypted env var |
| SLS_CONFIG_TYPE | config type for sls package vars. 'ssm', 'spring' or 'dotev' (default) |
| SLS_SPRING_CONFIG_ENDPOINT | endpoint url of spring config server eg. http://spring:8888 if SLS_CONFIG_TYPE is 'spring' |
| GTM_WORKER_SCRIPTS_CLONE | url of git repo to overlay on workspace eg. https://github.com/zotoio/gtm-worker-scripts.git |
| GTM_WORKER_SCRIPTS_PATH | directory within scripts clone repo to overlay |