Merge branch 'develop' into stable

10up · Jul 8, 2024 · 4b2d47a · 4b2d47a
2 parents 47459d3 + 05677ba
commit 4b2d47a
Show file tree

Hide file tree

Showing 6 changed files with 196 additions and 24 deletions.
diff --git a/.github/workflows/no-response.yml → .github/workflows/close-stale-issues.yml b/.github/workflows/no-response.yml → .github/workflows/close-stale-issues.yml
@@ -1,30 +1,36 @@
-name: No Response
+name: 'Close stale issues'
 
 # **What it does**: Closes issues where the original author doesn't respond to a request for information.
 # **Why we have it**: To remove the need for maintainers to remember to check back on issues periodically to see if contributors have responded.
-# **Who does it impact**: Everyone that works on docs or docs-internal.
 
 on:
-  issue_comment:
-    types: [created]
   schedule:
-    # Schedule for five minutes after the hour, every hour
-    - cron: '5 * * * *'
+    # Schedule for every day at 1:30am UTC
+    - cron: '30 1 * * *'
+
+permissions:
+  issues: write
 
 jobs:
-  noResponse:
+  stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: lee-dohm/[email protected]
+      - uses: actions/stale@v9
         with:
-          token: ${{ github.token }}
-          daysUntilClose: 14 # Number of days of inactivity before an Issue is closed for lack of response
-          responseRequiredLabel: "needs:feedback" # Label indicating that a response from the original author is required
-          closeComment: >
+          days-before-stale: 7
+          days-before-close: 7
+          stale-issue-message: >
+            It has been 7 days since more information was requested from you in this issue and we have not heard back. This issue is now marked as stale and will be closed in 7 days, but if you have more information to add then please comment and the issue will stay open.
+          close-issue-message: >
             This issue has been automatically closed because there has been no response
             to our request for more information. With only the
             information that is currently in the issue, we don't have enough information
             to take action. Please reach out if you have or find the answers we need so
             that we can investigate further. See [this blog post on bug reports and the
             importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/)
-            for more information about the kind of information that may be helpful.
+            for more information about the kind of information that may be helpful.
+          stale-issue-label: 'stale'
+          close-issue-reason: 'not_planned'
+          any-of-labels: 'needs:feedback'
+          remove-stale-when-updated: true
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.7.0] - 2024-07-01
+### Added
+- Arguments to allow the action to run the linter only on changed files or on changed lines (props [@kmgalanakis](https://github.com/kmgalanakis), [@faisal-alvi](https://github.com/faisal-alvi), [@fabiankaegy](https://github.com/fabiankaegy), [@dkotter](https://github.com/dkotter) via [#45](https://github.com/10up/wpcs-action/pull/45)).
+
+### Fixed
+- Using "WordPress" standards by installing from proper directory (props [@kmgalanakis](https://github.com/kmgalanakis), [@faisal-alvi](https://github.com/faisal-alvi), [@fabiankaegy](https://github.com/fabiankaegy), [@dkotter](https://github.com/dkotter) via [#47](https://github.com/10up/wpcs-action/pull/47)).
+
+### Developer
+- Replaced [lee-dohm/no-response](https://github.com/lee-dohm/no-response) with [actions/stale](https://github.com/actions/stale) to help with closing no-response/stale issues (props [@jeffpaul](https://github.com/jeffpaul), [@dkotter](https://github.com/dkotter) via [#43](https://github.com/10up/wpcs-action/pull/43)).
+
 ## [1.6.1] - 2023-08-30
 ### Fixed
 - Clone the 2.3.3 tagged release of the VIPCS package to ensure running VIP scans works (props [@dkotter](https://github.com/dkotter), [@TylerB24890](https://github.com/TylerB24890) via [#37](https://github.com/10up/wpcs-action/pull/37)).
@@ -67,6 +77,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `phpcs_bin_path` and `installed_paths` options.
 
 [Unreleased]: https://github.com/10up/wpcs-action/compare/stable...develop
+[1.7.0]: https://github.com/10up/wpcs-action/compare/v1.6.1...v1.7.0
 [1.6.1]: https://github.com/10up/wpcs-action/compare/v1.6.0...v1.6.1
 [1.6.0]: https://github.com/10up/wpcs-action/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/10up/wpcs-action/compare/v1.4.0...v1.5.0

diff --git a/CREDITS.md b/CREDITS.md
@@ -12,7 +12,7 @@ Note that this project was forked from [Ilya Chekalsky's](https://github.com/che
 
 Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.
 
-[Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Daniele Scasciafratte (@Mte90)](https://github.com/Mte90), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Vikram Moparthy (@vikrampm1)](https://github.com/vikrampm1), [Max Lyuchin (@cadic)](https://github.com/cadic), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Darin Kotter (@dkotter)](https://github.com/dkotter), [David Armstrong (@B-Interactive)](https://github.com/B-Interactive), [Konstantinos Galanakis (@kmgalanakis)](https://github.com/kmgalanakis), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Gary Jones (@GaryJones)](https://github.com/GaryJones), [Tyler Bailey (@TylerB24890)](https://github.com/TylerB24890).
+[Tung Du (@dinhtungdu)](https://github.com/dinhtungdu), [Daniele Scasciafratte (@Mte90)](https://github.com/Mte90), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Vikram Moparthy (@vikrampm1)](https://github.com/vikrampm1), [Max Lyuchin (@cadic)](https://github.com/cadic), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Siddharth Thevaril (@Sidsector9)](https://github.com/Sidsector9), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Darin Kotter (@dkotter)](https://github.com/dkotter), [David Armstrong (@B-Interactive)](https://github.com/B-Interactive), [Konstantinos Galanakis (@kmgalanakis)](https://github.com/kmgalanakis), [Faisal Alvi (@faisal-alvi)](https://github.com/faisal-alvi), [Gary Jones (@GaryJones)](https://github.com/GaryJones), [Tyler Bailey (@TylerB24890)](https://github.com/TylerB24890), [Fabian Kägy (@fabiankaegy)](https://github.com/fabiankaegy).
 
 ## Libraries
 

diff --git a/README.md b/README.md
@@ -58,6 +58,8 @@ Available options (with default value):
             phpcs_bin_path: 'phpcs' # Custom PHPCS bin path
             use_local_config: 'false' # Use local config if available
             extra_args: '' # Extra arguments passing to the command
+            only_changed_files: '' # Run the linter only on the changed files. Accepts true|false
+            only_changed_lines: '' # Run the linter only on the changed lines. Accepts true|false
 ```
 
 ## Examples
@@ -137,6 +139,28 @@ jobs:
           standard: 'WordPress' # Standard to use. Accepts WordPress|WordPress-Core|WordPress-Docs|WordPress-Extra|WordPress-VIP-Go|WordPressVIPMinimum|10up-Default.
           use_local_config: 'true'
 ```
+### Run linter on changed lines
+
+```yaml
+name: WPCS check
+
+on: pull_request
+
+jobs:
+  phpcs:
+    name: WPCS
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # This is very important. Without this the linting of only the changed lines will not work. 
+      - name: WPCS check
+        uses: 10up/wpcs-action@stable
+        with:
+          standard: 10up-Default
+          enable_warnings: true
+          only_changed_lines: true
+```
 
 ## Support Level
 

diff --git a/action.yml b/action.yml
@@ -38,6 +38,14 @@ inputs:
     description: 'Passing extra arguments to the phpcs command'
     required: false
     default: ''
+  only_changed_files:
+    description: 'Run linter on changed files only'
+    required: false
+    default: ''
+  only_changed_lines:
+    description: 'Report errors only for changed lines'
+    required: false
+    default: ''
 runs:
   using: 'docker'
   image: 'Dockerfile'

diff --git a/entrypoint.sh b/entrypoint.sh
@@ -4,27 +4,126 @@ cp /action/problem-matcher.json /github/workflow/problem-matcher.json
 
 git clone --depth 1 -b 2.3.0 https://github.com/WordPress/WordPress-Coding-Standards.git ~/wpcs
 
+git config --global --add safe.directory $(pwd)
+
+diff_lines() {
+  path=""
+  line=""
+  while IFS= read -r REPLY; do
+     esc=$(printf '\033')
+     if echo "$REPLY" | grep -qE '\-\-\- (a/)?.*'; then
+         continue
+     elif echo "$REPLY" | grep -qE '\+\+\+ (b/)?([^[:blank:]'"$esc"']+).*'; then
+         path=$(echo "$REPLY" | sed -E 's/\+\+\+ (b\/)?([^[:blank:]'"$esc"']+).*/\2/')
+     elif echo "$REPLY" | grep -qE '@@ -[0-9]+(,[0-9]+)? \+([0-9]+)(,[0-9]+)? @@.*'; then
+         line=$(echo "$REPLY" | sed -E 's/@@ -[0-9]+(,[0-9]+)? \+([0-9]+)(,[0-9]+)? @@.*/\2/')
+     elif echo "$REPLY" | grep -qE '^('"$esc"'\[[0-9;]*m)*([\\ +-])'; then
+         echo "$path:$line:$REPLY"
+         if echo "${REPLY}" | grep -qE '^('"$esc"'\[[0-9;]*m)*([\ +-])'; then
+             line=$((line+1))
+         fi
+     fi
+  done
+}
+
+filter_by_changed_lines() {
+    changedLines="$1"
+    fileName=
+    fileLine=
+    exitCode=0
+
+    while IFS= read -r line; do
+        if echo "$line" | grep -q -E '<file name="(\/github\/workspace\/)?([^"]+)'; then
+            fileName=$(echo "$line" | sed -E 's/.*<file name="(\/github\/workspace\/)?([^"]+).*/\2/')
+            echo "$line"
+        elif echo "$line" | grep -q -E '<error line="([^"]+)'; then
+            fileLine=$(echo "$line" | sed -E 's/.*<error line="([^"]+).*/\1/')
+            if echo "$changedLines" | grep -qx "$fileName:$fileLine"; then
+                exitCode=1
+                echo "$line"
+            fi
+        else
+            echo "$line"
+        fi
+    done
+    exit "$exitCode"
+}
+
+clean_diff_output() {
+  step1=$(git diff -U0 --diff-filter=d "${COMPARE_FROM_REF}" "${COMPARE_TO_REF}")
+  step2=$(echo "${step1}" | diff_lines)
+  step3=$(echo "${step2}" | grep -ve ':-')
+  step4=$(echo "${step3}" | sed 's/:+.*//') # On some platforms, sed needs to have + escaped.  This isn't the case for Alpine sed.
+  step5=$(echo "${step4}" | sed 's/:\\.*//')
+
+  echo "${step5}"
+}
+
+decide_all_files_or_changed() {
+  standards="$1"
+
+  if [ "${INPUT_ONLY_CHANGED_FILES}" = "true" ]; then
+      if [ "${INPUT_ONLY_CHANGED_LINES}" = "true" ]; then
+        set +e
+        echo "${CHANGED_FILES}" | xargs -rt ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths "${standards}" | filter_by_changed_lines "${clean_diff_output}"
+        set -e
+      else
+        echo "${CHANGED_FILES}" | xargs -rt ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths "${standards}"
+      fi
+  else
+      ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths "${standards}"
+  fi
+}
+
+INPUT_ONLY_CHANGED_FILES=${INPUT_ONLY_CHANGED_FILES:-${INPUT_ONLY_CHANGED_LINES:-"false"}}
+
+if [ "${INPUT_ONLY_CHANGED_FILES}" = "true" ]; then
+    if [ "${GITHUB_EVENT_NAME}" = "pull_request" ]; then
+        COMPARE_FROM=origin/${GITHUB_BASE_REF}
+        COMPARE_TO=origin/${GITHUB_HEAD_REF}
+
+        COMPARE_FROM_REF=$(git merge-base "${COMPARE_FROM}" "${COMPARE_TO}")
+        COMPARE_TO_REF=${COMPARE_TO}
+    else
+        COMPARE_FROM="HEAD^"
+        COMPARE_TO="HEAD"
+        COMPARE_FROM_REF="HEAD^"
+        COMPARE_TO_REF="HEAD"
+    fi
+    echo "Will only check changed files (${COMPARE_FROM_REF} -> ${COMPARE_TO_REF})"
+    set +e
+    CHANGED_FILES=$(git diff --name-only --diff-filter=d "${COMPARE_FROM_REF}" "${COMPARE_TO_REF}" | xargs -rt ls -1d 2>/dev/null)
+    set -e
+    echo "Will check files:"
+    echo "${CHANGED_FILES}"
+else
+    echo "Will check all files"
+fi
+
 if [ "${INPUT_STANDARD}" = "WordPress-VIP-Go" ] || [ "${INPUT_STANDARD}" = "WordPressVIPMinimum" ]; then
     echo "Setting up VIPCS"
     git clone --depth 1 -b 2.3.3 https://github.com/Automattic/VIP-Coding-Standards.git ${HOME}/vipcs
     git clone https://github.com/sirbrillig/phpcs-variable-analysis ${HOME}/variable-analysis
-    ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths "${HOME}/wpcs,${HOME}/vipcs,${HOME}/variable-analysis"
+
+    decide_all_files_or_changed "${HOME}/wpcs,${HOME}/vipcs,${HOME}/variable-analysis"
 elif [ "${INPUT_STANDARD}" = "10up-Default" ]; then
     echo "Setting up 10up-Default"
     git clone https://github.com/10up/phpcs-composer ${HOME}/10up
     git clone https://github.com/PHPCompatibility/PHPCompatibilityWP ${HOME}/phpcompatwp
     git clone https://github.com/PHPCompatibility/PHPCompatibility ${HOME}/phpcompat
     git clone https://github.com/PHPCompatibility/PHPCompatibilityParagonie ${HOME}/phpcompat-paragonie
-    git clone https://github.com/PHPCSStandards/PHPCSUtils ${HOME}/phpcsutils
+    git clone --depth 1 --branch 1.0.11 https://github.com/PHPCSStandards/PHPCSUtils ${HOME}/phpcsutils
     git clone https://github.com/Automattic/VIP-Coding-Standards ${HOME}/vipcs
     git clone https://github.com/sirbrillig/phpcs-variable-analysis ${HOME}/variable-analysis
-    ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths "${HOME}/wpcs,${HOME}/10up/10up-Default,${HOME}/phpcompatwp/PHPCompatibilityWP,${HOME}/phpcompat/PHPCompatibility,${HOME}/phpcompat-paragonie/PHPCompatibilityParagonieSodiumCompat,${HOME}/phpcompat-paragonie/PHPCompatibilityParagonieRandomCompat,${HOME}/phpcsutils/PHPCSUtils,${HOME}/vipcs,${HOME}/variable-analysis"
+
+    decide_all_files_or_changed "${HOME}/wpcs,${HOME}/10up/10up-Default,${HOME}/phpcompatwp/PHPCompatibilityWP,${HOME}/phpcompat/PHPCompatibility,${HOME}/phpcompat-paragonie/PHPCompatibilityParagonieSodiumCompat,${HOME}/phpcompat-paragonie/PHPCompatibilityParagonieRandomCompat,${HOME}/phpcsutils/PHPCSUtils,${HOME}/vipcs,${HOME}/variable-analysis"
 elif [ -z "${INPUT_STANDARD_REPO}" ] || [ "${INPUT_STANDARD_REPO}" = "false" ]; then
-    ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths ~/wpcs
+  decide_all_files_or_changed "${HOME}/wpcs"
 else
-    echo "Standard repository: ${INPUT_STANDARD_REPO}"
-    git clone -b ${INPUT_REPO_BRANCH} ${INPUT_STANDARD_REPO} ${HOME}/cs
-    ${INPUT_PHPCS_BIN_PATH} --config-set installed_paths "${HOME}/wpcs,${HOME}/cs"
+  echo "Standard repository: ${INPUT_STANDARD_REPO}"
+  git clone -b ${INPUT_REPO_BRANCH} ${INPUT_STANDARD_REPO} ${HOME}/cs
+
+  decide_all_files_or_changed "${HOME}/wpcs,${HOME}/cs"
 fi
 
 if [ -z "${INPUT_EXCLUDES}" ]; then
@@ -53,13 +152,37 @@ else
 fi
 
 if [ "${HAS_CONFIG}" = true ] && [ "${INPUT_USE_LOCAL_CONFIG}" = "true" ] ; then
-    ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle ${INPUT_EXTRA_ARGS}
+  if [ "${INPUT_ONLY_CHANGED_FILES}" = "true" ]; then
+      if [ "${INPUT_ONLY_CHANGED_LINES}" = "true" ]; then
+        set +e
+        echo "${CHANGED_FILES}" | xargs -rt ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle ${INPUT_EXTRA_ARGS} | filter_by_changed_lines "${clean_diff_output}"
+        status=$?
+        set -e
+      else
+        echo "${CHANGED_FILES}" | xargs -rt ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle ${INPUT_EXTRA_ARGS}
+        status=$?
+      fi
+  else
+      ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle ${INPUT_EXTRA_ARGS}
+      status=$?
+  fi
 else
+  if [ "${INPUT_ONLY_CHANGED_FILES}" = "true" ]; then
+    if [ "${INPUT_ONLY_CHANGED_LINES}" = "true" ]; then
+      set +e
+      echo "${CHANGED_FILES}" | xargs -rt ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle --standard=${INPUT_STANDARD} --extensions=php ${INPUT_EXTRA_ARGS} | filter_by_changed_lines "$(clean_diff_output)"
+      status=$?
+      set -e
+    else
+      echo "${CHANGED_FILES}" | xargs -rt ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle --standard=${INPUT_STANDARD} --extensions=php ${INPUT_EXTRA_ARGS}
+      status=$?
+    fi
+  else
     ${INPUT_PHPCS_BIN_PATH} ${WARNING_FLAG} --report=checkstyle --standard=${INPUT_STANDARD} --ignore=${EXCLUDES} --extensions=php ${INPUT_PATHS} ${INPUT_EXTRA_ARGS}
+    status=$?
+  fi
 fi
 
-status=$?
-
 echo "::remove-matcher owner=phpcs::"
 
 exit $status