README.md

circleci-build-trigger

Scheduler to build your CircleCI project with AWS Lambda.

⚠️ Deprecation warning ⚠️

CircleCI 2.0 released Scheduling Workflow.

I strongly recommend using Scheduling Workflow!!

Use case

Introduce use cases of this Lambda function.

• bitjourney/ci-npm-update
• masutaka/circleci-bundle-update-pr
• taichi/ci-yarn-upgrade

Quick Start

$ git clone [email protected]:tsub/circleci-build-trigger.git # or sls install -u https://github.com/tsub/circleci-build-trigger
$ cd circleci-build-trigger
$ npm install # or yarn install
$ cp serverless.env.yml{.template,} # and Set environment variables in serverless.env.yml
$ export AWS_ACCESS_KEY_ID=<YOUR AWS_ACCESS_KEY_ID>
$ export AWS_SECRET_ACCESS_KEY=<YOUR AWS_SECRET_ACCESS_KEY>
$ export AWS_REGION=<YOUR AWS_REGION>
$ npm run deploy -- -s prod # or yarn run deploy -- -s prod

Requirements

• Node.js
• yarn (option)

Require Environment variables

• $AWS_ACCESS_KEY_ID
• $AWS_SECRET_ACCESS_KEY
• $AWS_REGION or $AWS_DEFAULT_REGION

About serverless.env.yml

CIRCLE_TOKEN

Access token to access the CircleCI API.

CircleCI: Project Settings -> API Permissions -> Create a token with 'All' scope

PROJECT

GitHub repository to build.

e.g. tsub/circleci-build-trigger

BRANCH

Git branch to build.

e.g. master

TRIGGER_NAME

⚠️ [DEPRECATED] Recommend using CIRCLE_JOB

Key name to use the CircleCI build_parameters.

e.g. CIRCLECI_BUILD_TRIGGER

CIRCLE_JOB

📣 Can be used only with CircleCI 2.0

Building job name to use the CircleCI 2.0 CIRCLE_JOB.

e.g. continuous_bundle_update

SCHEDULE_EXPRESSION

Schedule rule to Start build.

Schedule Expression Syntax for Rules - Amazon CloudWatch Events

Examples

Run weekly.

rate(1 weeks)

Run at 00:00 am (UTC) every Monday.

cron(0 0 ? * Mon *)