Skip to content

Commit

Permalink
Merge pull request #227 from Yoast/feature/composer-update-dev-depend…
Browse files Browse the repository at this point in the history
…encies

Composer: update dev dependencies
  • Loading branch information
jrfnl committed Apr 6, 2024
2 parents 9f7c69a + 8dd1544 commit c1707a0
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 63 deletions.
12 changes: 10 additions & 2 deletions .github/workflows/cs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,23 @@ jobs:
custom-cache-suffix: $(date -u "+%Y-%m")

# Check the codestyle of the files against a threshold of expected errors and warnings.
# Keep track of the exit code as it determines whether to run the branch check or not.
# Exit code 128 means the thresholds needs to be lowered. Other exit codes imply CS errors.
- name: Check PHP code style against the thresholds
run: composer check-cs-thresholds
id: thresholds
run: |
set +e
composer check-cs-thresholds
exitcode="$?"
echo "EXITCODE=$exitcode" >> $GITHUB_OUTPUT
exit "$exitcode"
# Check the codestyle only of the files which were changed in the current branch.
# This step will only be executed if the threshold check exited with a failure status.
# The results of this CS check will be shown inline in the PR via the CS2PR tool.
# @link https://github.com/staabm/annotate-pull-request-from-checkstyle/
- name: Check PHP code style for the changes made in the branch only
if: ${{ failure() }}
if: ${{ failure() && steps.thresholds.outputs.EXITCODE != 128 }}
id: phpcs
run: composer check-branch-cs -- ${{ steps.base_branch.outputs.REF }}

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"ext-zip": "*"
},
"require-dev": {
"yoast/yoastcs": "^3.0"
"yoast/yoastcs": "^3.1.0"
},
"autoload": {
"classmap": [
Expand Down
122 changes: 63 additions & 59 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 14 additions & 1 deletion config/composer/actions.php
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,11 @@ public static function check_cs_thresholds() {
$above_threshold = false;
}

$threshold_exact = true;
if ( \strpos( $phpcs_output, ' than the threshold, great job!' ) !== false ) {
$threshold_exact = false;
}

/*
* Don't run the branch check in CI/GH Actions as it prevents the errors from being shown inline.
* The GH Actions script will run this via a separate script step.
Expand All @@ -167,7 +172,15 @@ public static function check_cs_thresholds() {
@\passthru( 'composer check-branch-cs' );
}

exit( ( $above_threshold === true || $return > 2 ) ? $return : 0 );
$exit_code = 0;
if ( $above_threshold === true || $return > 2 ) {
$exit_code = $return;
}
elseif ( $threshold_exact === false ) {
$exit_code = 128;
}

exit( $exit_code );
}

/**
Expand Down

0 comments on commit c1707a0

Please sign in to comment.