README

Installation

$ composer require --dev enomotodev/php-cs-fixer-commit 

Usage (GitHub + GitHub Actions)

Create workflow file

In .github/workflows , add a .yml or .yaml file for your workflow.

For example, .github/workflows/php-cs-fixer-commit.yml .

name: php-cs-fixer-commit on: push: jobs: php-cs-fixer-commit: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install Dependencies run: composer install - name: php-cs-fixer-commit env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: ./vendor/bin/php-cs-fixer-commit <username> <email>

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

Usage (GitHub + CircleCI)

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 php-cs-fixer-commit, for example:

version: 2 jobs: build: # ... fixer: steps: # ... - run: name: php-cs-fixer-commit command: ./vendor/bin/php-cs-fixer-commit <username> <email>

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

Usage (GitLab + GitLabCI)

Setting GitLab personal access token to GitLabCI

GitLab personal access token is required for sending merge requests to your repository.

1. Go to your account's settings page and generate a personal access token with "api" scope
2. On GitLab dashboard, go to your application's "Settings" -> "CI /CD" -> "Environment variables"
3. Add an environment variable GITLAB_API_PRIVATE_TOKEN with your GitLab personal access token

Configure .gitlab-ci.yml

Configure your .gitlab-ci.yml to run php-cs-fixer-commit, for example:

stages: # ... - fixer # ... fixer-commit: image: composer:latest stage: fixer script: - "composer install" - "$COMPOSER_HOME/vendor/bin/php-cs-fixer-commit <username> <email>"

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

License

php-cs-fixer-commit is open-sourced software licensed under the MIT license