enomotodev/circleci-composer-update-pr

Create PullRequest of composer update in CircleCI

1.1.0 2019-08-29 01:59 UTC

Requires

• php: ^5.6 || ^7.0
• enomotodev/composer-lock-diff: ^1.0@dev
• knplabs/github-api: ^2.9
• php-http/guzzle6-adapter: ^1.1

MIT

• enomotodev

• composer
• github
• CircleCI

README

Installation

$ composer require enomotodev/circleci-composer-update-pr

Prerequisites

The application on which you want to run continuous composer update must be configured to be built on CircleCI.

Usage

Setting GitHub personal access token to CircleCI

GitHub personal access token is required for sending pull requests to your repository.

1. Go to your account's settings page and generate a personal access token with "repo" scope
2. On CircleCI dashboard, go to your application's "Project Settings" -> "Environment Variables"
3. Add an environment variable GITHUB_ACCESS_TOKEN with your GitHub personal access token

Configure circle.yml

Configure your circle.yml or .circleci/config.yml to run circleci-composer-update-pr, for example:

version: 2
jobs:
  build:
    # snip
  continuous_composer_update:
    docker:
      - image: composer:latest
    working_directory: /work
    steps:
      - run:
          name: Set timezone to Asia/Tokyo
          command: echo "date.timezone=Asia/Tokyo" > "$PHP_INI_DIR/conf.d/date_timezone.ini"
      - checkout
      - restore_cache:
          name: Restore composer cache
          keys:
            - composer-{{ .Environment.COMMON_CACHE_KEY }}-{{ checksum "composer.lock" }}
            - composer-{{ .Environment.COMMON_CACHE_KEY }}-
      - run:
          name: Setup requirements for continuous composer update
          command: composer global require enomotodev/circleci-composer-update-pr
      - deploy:
          name: Continuous composer update
          command: $COMPOSER_HOME/vendor/bin/circleci-composer-update-pr <username> <email> master

workflows:
  version: 2
  build:
    jobs:
      - build:
          # snip
  nightly:
    triggers:
      - schedule:
          cron: "00 10 * * 5"
          filters:
            branches:
              only: master
    jobs:
      - continuous_composer_update

NOTE: Please make sure you replace <username> and <email> with yours.

CLI command references

General usage:

$ circleci-compsoser-update-pr <git username> <git email address> <git base branch>

License

circleci-compsoser-update-pr is open-sourced software licensed under the MIT license