https://github.com/enomotodev/php-cs-fixer-commit

Create commit of php-cs-fixer
https://github.com/enomotodev/php-cs-fixer-commit

circleci gitlab-ci php

Last synced: about 2 months ago
JSON representation

Create commit of php-cs-fixer

• Host: GitHub
• URL: https://github.com/enomotodev/php-cs-fixer-commit
• Owner: enomotodev
• Created: 2019-06-18T04:09:56.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-10-05T07:51:23.000Z (almost 3 years ago)
• Last Synced: 2024-07-16T04:41:46.973Z (2 months ago)
• Topics: circleci, gitlab-ci, php
• Language: PHP
• Homepage:
• Size: 7.81 KB
• Stars: 18
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# php-cs-fixer-commit

## 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` .

```yaml

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  

```

NOTE: Please make sure you replace `` and `` 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](https://github.com/settings/tokens) and generate a personal access token with "repo" scope

1. On CircleCI dashboard, go to your application's "Project Settings" -> "Environment Variables"

1. 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:

```yaml

version: 2

jobs:

  build:

    # ...

    fixer:

      steps:

        # ...

        - run:

            name: php-cs-fixer-commit

            command: ./vendor/bin/php-cs-fixer-commit  

```

NOTE: Please make sure you replace `` and `` 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](https://gitlab.com/profile/personal_access_tokens) and generate a personal access token with "api" scope

1. On GitLab dashboard, go to your application's "Settings" -> "CI /CD" -> "Environment variables"

1. 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:

```yaml

stages:

  # ...

  - fixer

# ...

fixer-commit:

  image: composer:latest

  stage: fixer

  script:

    - "composer install"

    - "$COMPOSER_HOME/vendor/bin/php-cs-fixer-commit  "

```

NOTE: Please make sure you replace `` and `` with yours.

## License

php-cs-fixer-commit is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)