VACMS-9885 site previewer #4596
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Contextual Advice | |
| on: | |
| - pull_request_target | |
| permissions: | |
| pull-requests: write | |
| jobs: | |
| # Provide context-specific advice to reviewers based on the files touched. | |
| contextual_advice: | |
| name: Contextual Advice | |
| runs-on: ubuntu-latest | |
| steps: | |
| # The following checks out the code from the pull request. | |
| # | |
| # This is not normally secure or recommended. It is safe in this context, | |
| # however, because we are not executing any code located within the PR | |
| # branch or its commits, regardless of provenance. | |
| # | |
| # Do not execute any code located within the repository! | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| fetch-depth: 0 | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| # To create advice for a file or directory, determine the filename by: | |
| # $ echo "$filename" | sed -E 's/[^[:alnum:]]+/_/g' | |
| # | |
| # (Leave off trailing '/' for directories.) | |
| # | |
| # Then add `.md` to the end of the resulting string and stick it in | |
| # the advice folder. | |
| # | |
| # E.g.: | |
| # | |
| # .gitignore -> _gitignore.md | |
| # .github/actions/post-checkout/action.yml -> _github_actions_post_checkout_action_yml.md | |
| # config/sync/core.extension.yml -> config_sync_core_extension_yml.md | |
| # docroot/sites/default -> docroot_sites_default.md | |
| # | |
| - name: Find available advice for each modified file. | |
| id: find_advice | |
| continue-on-error: true | |
| run: | | |
| mkdir -p ./.pr_advice; | |
| advice_path=".github/workflows/config/advice/"; | |
| while read filename; do | |
| echo "::debug::Looking for relevant advice for ${filename}..."; | |
| IFS='/' read -r -a path_components <<< "${filename}"; | |
| advice_file_path="${advice_path}"; | |
| advice_filename=""; | |
| # We'll separate path components by underscore, but we don't want | |
| # a leading underscore in the filename. So we'll set the delimiter | |
| # to an underscore after the first path component is processed. | |
| delimiter=""; | |
| for path_component in "${path_components[@]}"; do | |
| sanitized="$(echo "${path_component}" | sed -E 's/[^[:alnum:]]+/_/g')"; | |
| advice_file_path="${advice_file_path}${delimiter}${sanitized}"; | |
| echo "::debug::Looking in ${advice_file_path}.md ..."; | |
| if [ -f "${advice_file_path}.md" ]; then | |
| if [ ! -z "${advice_filename}" ]; then | |
| echo "::debug::Discarding advice in ${advice_filename} for (presumably) more relevant advice..."; | |
| fi; | |
| advice_filename="${advice_file_path}.md"; | |
| echo "::debug::Found relevant advice for ${filename} at ${advice_filename}."; | |
| fi; | |
| # Join second and subsequent path components with an underscore. | |
| delimiter="_"; | |
| done; | |
| if [ ! -z "${advice_filename}" ]; then | |
| cp "${advice_filename}" ./.pr_advice/; | |
| echo "provide_advice=true" >> $GITHUB_OUTPUT; | |
| else | |
| echo "::debug::... none found."; | |
| fi; | |
| done < <(git diff --name-only "${GITHUB_BASE_SHA}" "${GITHUB_PR_SHA}"); | |
| env: | |
| GITHUB_BASE_SHA: ${{ github.event.pull_request.base.sha }} | |
| GITHUB_PR_SHA: ${{ github.event.pull_request.head.sha }} | |
| - name: Provide advice in a PR comment. | |
| if: steps.find_advice.outputs.provide_advice == 'true' | |
| continue-on-error: true | |
| run: | | |
| # Find comments containing token, if any, and delete them. | |
| gh api \ | |
| -H "Accept: application/vnd.github+json" \ | |
| /repos/${GITHUB_REPOSITORY}/issues/${GITHUB_PR}/comments \ | |
| | jq '.[] | select(.body | contains("<!-- PR Advice -->")).id' \ | |
| | while read -r pr_comment; do \ | |
| gh api \ | |
| --method DELETE \ | |
| -H "Accept: application/vnd.github+json" \ | |
| "/repos/${GITHUB_REPOSITORY}/issues/comments/${pr_comment}"; \ | |
| done; | |
| body="$(awk 'FNR==1 && NR!=1 {print "\n<hr/>\n"}{print}' ./.pr_advice/*.md)"; | |
| # Create a new comment containing the compiled advice. | |
| gh api \ | |
| --method POST \ | |
| -H "Accept: application/vnd.github+json" \ | |
| /repos/${GITHUB_REPOSITORY}/issues/${GITHUB_PR}/comments \ | |
| -f body="<!-- PR Advice --> | |
| ${body}"; | |
| env: | |
| GITHUB_PR: "${{ github.event.pull_request.number }}" | |
| GITHUB_PR_SHA: ${{ github.event.pull_request.head.sha }} | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |