|
| 1 | +--- |
| 2 | +name: "PHP Code Beautifier and Fixer" |
| 3 | +description: Sniff the PHP code and beautify it if necessary. |
| 4 | + |
| 5 | +author: |
| 6 | + name: "Stanislav Rejthar" |
| 7 | + email: "rejthar@stanislavrejthar.com" |
| 8 | + url: "https://github.com/WorkOfStan" |
| 9 | + |
| 10 | +branding: |
| 11 | + icon: "check-circle" |
| 12 | + color: "blue" |
| 13 | + |
| 14 | +inputs: |
| 15 | + commit-changes: |
| 16 | + description: "If true, commit changes to the current branch" |
| 17 | + type: boolean |
| 18 | + default: false |
| 19 | + commit-message: |
| 20 | + description: "Commit message for the changes" |
| 21 | + type: string |
| 22 | + default: "PHP Code Beautifier fixes applied automatically" |
| 23 | + # https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Advanced-Usage#specifying-valid-file-extensions |
| 24 | + # By default, PHP_CodeSniffer will check any file it finds with a .inc, .php, .js or .css extension, although not all standards will actually check all these file types. |
| 25 | + # Empty value means no checking at all. |
| 26 | + # The default is `php` as js and css are handled by prettier. |
| 27 | + # Btw: JS/CSS support will be removed from PHP_CodeSniffer in PHPCS 4.x. Source: https://phpcsutils.com/ |
| 28 | + extensions: |
| 29 | + description: "Comma delimited list of extensions to be sniffed" |
| 30 | + required: false |
| 31 | + type: string |
| 32 | + default: "php" # "php,inc,lib" |
| 33 | + ignore: |
| 34 | + description: "Ignore files based on a comma-separated list of patterns matching files and/or directories." |
| 35 | + required: false |
| 36 | + type: string |
| 37 | + default: "vendor/" |
| 38 | + php-version: |
| 39 | + description: "PHP version to be used for running phpcs and phpcbf" |
| 40 | + required: false |
| 41 | + type: string |
| 42 | + default: "8.2" |
| 43 | + standard: |
| 44 | + description: "The name of, or the path to, the coding standard to use. Can be a comma-separated list specifying multiple standards." |
| 45 | + required: false |
| 46 | + type: string |
| 47 | + default: "" # if left empty, .github/linters/phpcs.xml or https://github.com/super-linter/super-linter/blob/main/TEMPLATES/phpcs.xml will be used |
| 48 | + |
| 49 | +outputs: |
| 50 | + branch-name: |
| 51 | + description: "The branch where changes were committed" |
| 52 | + |
| 53 | +runs: |
| 54 | + using: "composite" |
| 55 | + steps: |
| 56 | + - name: Checkout code |
| 57 | + uses: actions/checkout@v4 |
| 58 | + with: |
| 59 | + ref: ${{ github.ref }} # Fetch latest changes (even by previous job) |
| 60 | + fetch-depth: 0 # Fetch all history for all branches and tags. Otherwise github.event.pull_request.base.ref SHA isn't found. |
| 61 | + |
| 62 | + # Fetch latest changes (even by previous job) |
| 63 | + - name: Fetch latest changes |
| 64 | + run: git pull origin ${{ github.ref }} |
| 65 | + |
| 66 | + - name: Set up PHP |
| 67 | + uses: shivammathur/setup-php@v2 |
| 68 | + with: |
| 69 | + php-version: "${{ inputs.php-version }}" |
| 70 | + tools: composer:v2 |
| 71 | + |
| 72 | + - name: "Use the latest PHPCS version" |
| 73 | + run: composer require --dev squizlabs/php_codesniffer --prefer-dist --no-progress |
| 74 | + |
| 75 | + - name: Run PHP Code Sniffer |
| 76 | + id: phpcs |
| 77 | + run: | |
| 78 | + # Check if the repo has its own phpcs.xml config file |
| 79 | + if [ -f .github/linters/phpcs.xml ]; then |
| 80 | + standard=".github/linters/phpcs.xml" |
| 81 | + else |
| 82 | + # Fallback to the action’s default phpcs.xml template. |
| 83 | + # In a GitHub Action, GITHUB_ACTION_PATH points to the action’s source directory. |
| 84 | + standard="$GITHUB_ACTION_PATH/.github/linters/super-linter-templates-phpcs.xml" |
| 85 | + # Which is a copy of https://github.com/super-linter/super-linter/blob/main/TEMPLATES/phpcs.xml |
| 86 | + fi |
| 87 | + vendor/bin/phpcs --extensions="${{ inputs.extensions }}" . --standard="${{ inputs.standard || $standard }}" --ignore="${{ inputs.ignore }}" || HAS_ISSUES=true |
| 88 | + # because of `||`, the previous command always exit 0 |
| 89 | + |
| 90 | + # Default the variable if no issues were found |
| 91 | + : "${HAS_ISSUES:=false}" |
| 92 | + echo "HAS_ISSUES=$HAS_ISSUES" >> "$GITHUB_ENV" |
| 93 | + shell: bash |
| 94 | + |
| 95 | + - name: Run PHP Code Beautifier if needed |
| 96 | + if: env.HAS_ISSUES == 'true' |
| 97 | + run: | |
| 98 | + vendor/bin/phpcbf --extensions="${{ inputs.extensions }}" . --standard=.github/linters/phpcs.xml --ignore=vendor/ || echo "::warning title=Some phpcs issues remained::Manual fix necessary. Compare to the PHP Code Sniffer section above." |
| 99 | + |
| 100 | + # restore composer.json before staging the changes |
| 101 | + git checkout composer.json |
| 102 | + git add . |
| 103 | + |
| 104 | + # Determine branch name based on commit-changes input |
| 105 | + if ${{ inputs.commit-changes }}; then |
| 106 | + BRANCH_NAME=$(git branch --show-current) |
| 107 | + NOTICE_MESSAGE="A PHPCBF commit was successfully added to the current branch: $BRANCH_NAME" |
| 108 | + else |
| 109 | + # name includes timestamp and short_hash |
| 110 | + BRANCH_NAME="phpcbf/fix-$(date +'%y%m%d%H%M%S')-$(git rev-parse --short HEAD)" |
| 111 | + git checkout -b "$BRANCH_NAME" |
| 112 | + echo "::warning title=New branch created::Consider pull request for a new branch: $BRANCH_NAME (or delete it)" |
| 113 | + NOTICE_MESSAGE="A PHPCBF commit was successfully added to the new branch: $BRANCH_NAME" |
| 114 | + fi |
| 115 | + |
| 116 | + # Configure Git user |
| 117 | + git config user.name "github-actions[bot]" |
| 118 | + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" |
| 119 | + |
| 120 | + # Commit and push changes with custom message |
| 121 | + git commit -m "${{ inputs.commit-message }} on $(date +'%Y-%m-%d %H:%M:%S') UTC" |
| 122 | + git push origin "$BRANCH_NAME" |
| 123 | + echo "::notice title=Commit added::$NOTICE_MESSAGE" |
| 124 | + |
| 125 | + # Set branch name as output |
| 126 | + echo "branch-name=$BRANCH_NAME" >> $GITHUB_OUTPUT |
| 127 | + shell: bash |
0 commit comments