Skip to content

Fix PHPcs baseline test failure when there are no files to check #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 12, 2023
Merged

Fix PHPcs baseline test failure when there are no files to check #115

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c5c4ebe
fix: baseline coding standard fail when there are no files
Tjitse-E Sep 7, 2023
18525df
feat: also scan graphql/css/less/js files with phpcs
Tjitse-E Sep 7, 2023
b376bd2
Testing checkout head and base
Tjitse-E Sep 11, 2023
ec081b3
Test
Tjitse-E Sep 11, 2023
a983711
Test
Tjitse-E Sep 11, 2023
f982c49
Test
Tjitse-E Sep 11, 2023
5c8b335
Test
Tjitse-E Sep 11, 2023
443a0b3
Cleanup
Tjitse-E Sep 11, 2023
80af896
Cleanup
Tjitse-E Sep 11, 2023
b776674
Test
Tjitse-E Sep 11, 2023
0ddcedb
Fix
Tjitse-E Sep 11, 2023
4f934c1
Fix baseline
Tjitse-E Sep 11, 2023
7c472c7
Refactor
Tjitse-E Sep 11, 2023
a469ea4
Renaming
Tjitse-E Sep 11, 2023
801e35f
Rename step
Tjitse-E Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 69 additions & 38 deletions coding-standard-baseline/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,74 +48,105 @@ inputs:
runs:
using: composite
steps:
- name: Checkout Project
uses: actions/checkout@v3
- name: Checkout head
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{github.event.pull_request.head.ref}}
repository: ${{github.event.pull_request.head.repo.full_name}}

- name: Set PHP Version
- name: Get all changed files
uses: tj-actions/changed-files@v39
id: changed-files-phpcs
with:
files_yaml: |
app:
- '**/*.php'
- '**/*.phtml'
- '**/*.graphqls'
- '**/*.less'
- '**/*.css'
- '**/*.html'
- '**/*.xml'
- '**/*.js'

- name: Inform if no files have changed
if: steps.changed-files-phpcs.outputs.app_any_changed == 'false'
shell: bash
run: |
echo "No files relevant to PHPCS have changed. Skipping PHPCS run."
echo "List all the files that have changed: ${{ steps.changed-files-phpcs.outputs.app_all_changed_files }}"

- name: Inform if relevant files have changed
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
shell: bash
run: |
echo "One or more files relevant to PHPCS have changed."
echo "List all the files that have changed: ${{ steps.changed-files-phpcs.outputs.app_all_changed_files }}"

- name: Setup PHP
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
uses: shivammathur/setup-php@v2
with:
php-version: ${{ inputs.php_version }}
tools: composer:v${{ inputs.composer_version }}
coverage: none

- name: Install Coding Standard && Codesniffer baseline
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
shell: bash
run: |
git config --global advice.detachedHead false
composer require "magento/magento-coding-standard: ${{ github.event.inputs.version || '*' }}" -W
composer config --no-plugins allow-plugins.digitalrevolution/php-codesniffer-baseline true
composer require --dev "digitalrevolution/php-codesniffer-baseline: ${{ github.event.inputs.baseline_version || '*' }}"

- name: Register Coding Standard
- name: Register coding standards
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
shell: bash
run: vendor/bin/phpcs --config-set installed_paths ${{ github.workspace }}/vendor/magento/magento-coding-standard,${{ github.workspace }}/vendor/phpcompatibility/php-compatibility
run: |
${{ github.workspace }}/vendor/bin/phpcs --config-set installed_paths \
${{ github.workspace }}/vendor/magento/magento-coding-standard,${{ github.workspace }}/vendor/phpcompatibility/php-compatibility

- name: Get all changed files
uses: tj-actions/changed-files@v37
- name: Checkout base to generate baseline
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
uses: actions/checkout@v4
with:
write_output_files: true
output_dir: ${{ github.workspace }}
separator: " "
ref: ${{github.event.pull_request.base.ref}}
repository: ${{github.event.pull_request.base.repo.full_name}}
path: base

- name: Verify the contents of the modified_files.txt file
- name: Create phpcs.baseline.xml from base
shell: bash
working-directory: base
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
run: |
sed "s/ /\n/g" ${{ github.workspace }}/modified_files.txt > ${{ github.workspace }}/newline_file.txt
grep -iE "\.php|\.phtml|\.html|\.xml" ${{ github.workspace }}/newline_file.txt > ${{ github.workspace }}/phpcs_files.txt || /bin/true
php ${{ github.workspace }}/vendor/bin/phpcs --standard=Magento2 \
$([ -n "${{ inputs.severity }}" ] && echo "--severity=${{ inputs.severity }}") \
$([ -n "${{ inputs.warning_severity }}" ] && echo "--warning-severity=${{ inputs.warning_severity }}") \
$([ -n "${{ inputs.error_severity }}" ] && echo "--error-severity=${{ inputs.error_severity }}") \
--report=\\DR\\CodeSnifferBaseline\\Reports\\Baseline --report-file=phpcs.baseline.xml \
${{ steps.changed-files-phpcs.outputs.app_all_changed_files }} || /bin/true

- name: Checkout - Before Merge
- name: Copy baseline to head
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
shell: bash
if: test -s ${{ github.workspace }}/phpcs_files.txt
run: |
if ${{ github.event_name == 'pull_request' }}; then
git checkout ${{ github.event.pull_request.base.ref }}
else
git checkout ${{ github.event.before }}
fi
cp ${{ github.workspace }}/base/phpcs.baseline.xml ${{ github.workspace }}/phpcs.baseline.xml

- name: Filter php files and execute phpcs - Before Merge
# Since we ran phpcs in the base folder, the files in phpcs.baseline.xml contain the base folder in the path.
# We need to remove /base/ so that the phpcs can locate the correct files.
- name: Remove base dir from phpcs baseline
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
shell: bash
if: test -s ${{ github.workspace }}/phpcs_files.txt
run: |
php vendor/bin/phpcs --standard=Magento2 \
$([ -n "${{ inputs.severity }}" ] && echo "--severity=${{ inputs.severity }}") \
$([ -n "${{ inputs.warning_severity }}" ] && echo "--warning-severity=${{ inputs.warning_severity }}") \
$([ -n "${{ inputs.error_severity }}" ] && echo "--error-severity=${{ inputs.error_severity }}") \
--report=\\DR\\CodeSnifferBaseline\\Reports\\Baseline --report-file=${{ github.workspace }}/phpcs.baseline.xml --file-list=${{ github.workspace }}/phpcs_files.txt || /bin/true
sed -i "s|/base/|/|" ${{ github.workspace }}/phpcs.baseline.xml

- name: Checkout after Merge and execute phpcs
- name: Execute phpcs on head for changed files
shell: bash
if: test -s ${{ github.workspace }}/phpcs_files.txt
run: |
if ${{ github.event_name == 'pull_request' }}; then
git checkout ${{ github.event.pull_request.head.ref }}
else
git checkout ${{ github.event.after }}
fi
php vendor/bin/phpcs --standard=Magento2 \
if: steps.changed-files-phpcs.outputs.app_any_changed == 'true'
run: |
php ${{ github.workspace }}/vendor/bin/phpcs --standard=Magento2 \
$([ -n "${{ inputs.severity }}" ] && echo "--severity=${{ inputs.severity }}") \
$([ -n "${{ inputs.warning_severity }}" ] && echo "--warning-severity=${{ inputs.warning_severity }}") \
$([ -n "${{ inputs.error_severity }}" ] && echo "--error-severity=${{ inputs.error_severity }}") \
--file-list=${{ github.workspace }}/phpcs_files.txt
${{ steps.changed-files-phpcs.outputs.app_all_changed_files }}