From 748060e0b1ce60206c4be417b8ab05ee70d62fff Mon Sep 17 00:00:00 2001 From: ginokent <29125616+ginokent@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:03:44 +0900 Subject: [PATCH] feat: Create action.yml --- .github/CODEOWNERS | 2 + .github/dependabot.yml | 22 +++ .github/pull_request_template.md | 31 ++++ .github/release.yml | 38 +++++ .github/workflows/auto-assign.yml | 20 +++ .github/workflows/example.yml | 32 ++++ .github/workflows/label-checker.yml | 80 ++++++++++ .github/workflows/task-list-checker.yml | 23 +++ .github/workflows/typo-checker.yml | 46 ++++++ LICENSE | 201 +++++++++++++++++++++++ README.md | 40 +++++ action.yml | 202 ++++++++++++++++++++++++ 12 files changed, 737 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/dependabot.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/release.yml create mode 100644 .github/workflows/auto-assign.yml create mode 100644 .github/workflows/example.yml create mode 100644 .github/workflows/label-checker.yml create mode 100644 .github/workflows/task-list-checker.yml create mode 100644 .github/workflows/typo-checker.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 action.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..1500e3a --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# ref: https://docs.github.com/ja/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners +* @hakadoriya/owner diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..4a0ef41 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,22 @@ +version: 2 +updates: + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + day: "monday" + time: "11:00" + timezone: "Asia/Tokyo" + commit-message: + prefix: "ci(github-actions): " + labels: + - "ci" + assignees: + - "hakadoriya/owner" + reviewers: + - "hakadoriya/owner" + groups: + dependencies: + patterns: + - "*" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9b3eb81 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ + + +## Ticket / Issue Number + +> **Note** +> *Please fill in the ticket or issue number.* +> > Example: +> > +> > #1 + +## What's changed + +> **Note** +> *Please explain what changes this pull request will make.* +> > Example: +> > +> > - Added functionality to perform 'bar' on 'foo'. + +## Check List + +- [ ] Assign reviewers +- [ ] Assign assignees +- [ ] Assign labels +- [ ] Add appropriate test cases + +## Remark + +> **Note** +> *Please provide additional remarks if necessary.* + + diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..d60acb1 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,38 @@ +# https://docs.github.com/ja/repositories/releasing-projects-on-github/automatically-generated-release-notes +changelog: + categories: + - title: "💥 BREAKING CHANGES" + labels: + - BREAKING CHANGE + - title: "⬆️ Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)" + labels: + - build + - dependencies + - title: "👷 Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)" + labels: + - ci + - title: "📝 Documentation only changes" + labels: + - docs + - title: "✨ A new feature" + labels: + - feat + - title: "🐛 A bug fix" + labels: + - fix + - title: "⚡️ A code change that improves performance" + labels: + - perf + - title: "♻️ A code change that neither fixes a bug nor adds a feature" + labels: + - refactor + - title: "✅ Adding missing tests or correcting existing tests" + labels: + - test + - title: "🚨 Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)" + labels: + - style + - title: "🧑‍💻 Changes to the build process or auxiliary tools and libraries such as documentation generation" + labels: + - chore + - "*" diff --git a/.github/workflows/auto-assign.yml b/.github/workflows/auto-assign.yml new file mode 100644 index 0000000..5e39f08 --- /dev/null +++ b/.github/workflows/auto-assign.yml @@ -0,0 +1,20 @@ +name: auto-assign + +on: + pull_request: + types: + - opened + - ready_for_review + - reopened + +jobs: + auto-assign: + if: github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]' + runs-on: ubuntu-latest + timeout-minutes: 2 + steps: + - if: ${{ toJSON(github.event.pull_request.assignees) == '[]' }} + env: + GH_TOKEN: ${{ github.token }} + run: | + gh pr --repo ${{ github.repository }} edit ${{ github.event.pull_request.number }} --add-assignee "${{ github.event.pull_request.user.login }}" diff --git a/.github/workflows/example.yml b/.github/workflows/example.yml new file mode 100644 index 0000000..617b646 --- /dev/null +++ b/.github/workflows/example.yml @@ -0,0 +1,32 @@ +name: example + +on: + push: + # NO paths filter + pull_request: + # NO paths filter + workflow_dispatch: + +jobs: + missing-final-newline: + runs-on: ubuntu-latest + outputs: + missing: ${{ steps.missing-final-newline.outputs.missing }} + missing-files: ${{ steps.missing-final-newline.outputs.missing-files }} + steps: + - uses: hakadoriya/github-actions-missing-final-newline@develop + id: missing-final-newline + with: + paths: |- + ^action.yml + # > Note: A job that is skipped will report its status as "Success". + # > It will not prevent a pull request from merging, even if it is a required check. + # ref. https://docs.github.com/en/actions/using-jobs/using-conditions-to-control-job-execution#overview + missing: + runs-on: ubuntu-latest + needs: missing-final-newline + if: ${{ needs.missing-final-newline.outputs.missing == 'true' }} + steps: + - name: "if not skip" + run: | + echo "needs.missing-final-newline.outputs.missing-files: ${{ needs.missing-final-newline.outputs.missing-files }}" diff --git a/.github/workflows/label-checker.yml b/.github/workflows/label-checker.yml new file mode 100644 index 0000000..7067328 --- /dev/null +++ b/.github/workflows/label-checker.yml @@ -0,0 +1,80 @@ +name: label-checker + +# # Dependabot +# gh label create --force "dependencies" --description "Pull requests that update a dependency file" --color 0366D6 +# gh label create --force "go" --description "Pull requests that update Go code" --color 16E2E2 +# gh label create --force "github_actions" --description "Pull requests that update GitHub Actions code" --color 000000 +# gh label create --force "docker" --description "Pull requests that update Docker code" --color 21CEFF + +# # Renovate +# gh label create --force "renovate" --description "Renovate" --color 009485 + +# # Commit prefix +# gh label create --force "BREAKING CHANGE" --description "BREAKING CHANGES" --color FF0303 +# gh label create --force "build" --description "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)" --color 5319E7 +# gh label create --force "ci" --description "Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)" --color 53C4EE +# gh label create --force "docs" --description "Documentation only changes" --color 1B3E44 +# gh label create --force "feat" --description "A new feature" --color 0EAA80 +# gh label create --force "fix" --description "A bug fix" --color 1D76DB +# gh label create --force "perf" --description "A code change that improves performance" --color A2EEEF +# gh label create --force "refactor" --description "A code change that neither fixes a bug nor adds a feature" --color C5DEF5 +# gh label create --force "test" --description "Adding missing tests or correcting existing tests" --color 1D76DB +# gh label create --force "chore" --description "Changes to the build process or auxiliary tools and libraries such as documentation generation" --color 20313F + +on: + pull_request: + types: + - opened + - edited + - labeled + - unlabeled + - ready_for_review + - reopened + - synchronize + +env: + LABELS: "BREAKING CHANGE,build,ci,docs,feat,fix,perf,refactor,test,chore" + +jobs: + label-checker: + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + id-token: write + contents: read + pull-requests: write # required to add labels + statuses: read + checks: read + repository-projects: read + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ github.event.pull_request.head.ref }} # needed for gh pr view + - name: Check labels + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + shell: bash + run: | + # Check labels + set -Eeuo pipefail -x + + # If any of the labels are present, exit with success + if [[ -n "$(gh pr view --json labels --jq ".labels[].name" | grep -E "^($(tr , "|" <<<"${LABELS:?}"))$")" ]]; then + exit 0 + fi + + # Add labels based on PR title + GH_PR_TITLE=$(gh pr view --json title --jq .title) + gh label list --json name --jq ".[].name" | while read -r LINE; do + awk -F: "/^${LINE-}(\([^\)]+\))?:/ {print \$1}" <<<"${GH_PR_TITLE:?}" | grep -Eo "^${LINE:?}" || true # NOTE: Ignore the return value of grep because we just want to output the string + done | xargs -t -I{} gh pr edit --add-label {} + + # If any of the labels are present, exit with success + while read -r LINE; do + if grep -E "^($(tr , "|" <<<"${LABELS:?}"))$" <<<"${LINE-}"; then + exit 0 + fi + done <<<"$(gh pr view --json labels --jq ".labels[].name")" + + # If none of the labels are present, exit with error + exit 1 diff --git a/.github/workflows/task-list-checker.yml b/.github/workflows/task-list-checker.yml new file mode 100644 index 0000000..38f0181 --- /dev/null +++ b/.github/workflows/task-list-checker.yml @@ -0,0 +1,23 @@ +name: task-list-checker + +on: + pull_request: + types: + - opened + - edited + - ready_for_review + - reopened + - synchronize + +jobs: + task-list-checker: + if: github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]' + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + contents: read + pull-requests: read + steps: + - uses: hakadoriya/github-actions-task-list-checker@v0.0.0 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/typo-checker.yml b/.github/workflows/typo-checker.yml new file mode 100644 index 0000000..606bb3e --- /dev/null +++ b/.github/workflows/typo-checker.yml @@ -0,0 +1,46 @@ +name: typo-checker +# ^^^^^^^^^^^^ +# https://github.com/organization/repository/workflows/typo-checker/badge.svg +# ^^^^^^^^^^^^ + +on: + pull_request: + workflow_dispatch: + inputs: {} + +# NOTE: If commit & push continuously, cancel the workflow other than the latest commit. +concurrency: + group: ${{ github.workflow }}-${{ github.base_ref }}-${{ github.head_ref }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + id-token: write + contents: read + +env: + WORKDIR: . + +defaults: + run: + shell: bash + +jobs: + typo-checker: # NOTE: for Branch protection rule `Status checks that are required.` + runs-on: ubuntu-latest # ref. https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on + steps: + - uses: actions/checkout@v4 + - name: DEBUG + shell: bash + run: | + cat <<'DEBUG_DOC' + == DEBUG ======================================================= + github.ref: ${{ github.ref }} + github.event_name: ${{ github.event_name }} + -- toJSON(github.event.inputs) --------------------------------- + ${{ toJSON(github.event.inputs) }} + -- toJSON(github) ---------------------------------------------- + ${{ toJSON(github) }} + ================================================================ + DEBUG_DOC + - name: Check spelling + uses: crate-ci/typos@master diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8880c4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 hakadoriya + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..754993e --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# GitHub Actions Missing Final Newline + +A workflow to check missing final newline. + +## example + +```yml +name: example + +on: + push: + # NO paths filter + pull_request: + # NO paths filter + workflow_dispatch: + +jobs: + missing-final-newline: + runs-on: ubuntu-latest + outputs: + missing: ${{ steps.missing-final-newline.outputs.missing }} + missing-files: ${{ steps.missing-final-newline.outputs.missing-files }} + steps: + - uses: hakadoriya/github-actions-missing-final-newline@main + id: missing-final-newline + with: + paths: |- + ^action.yml + # > Note: A job that is skipped will report its status as "Success". + # > It will not prevent a pull request from merging, even if it is a required check. + # ref. https://docs.github.com/en/actions/using-jobs/using-conditions-to-control-job-execution#overview + missing: + runs-on: ubuntu-latest + needs: missing-final-newline + if: ${{ needs.missing-final-newline.outputs.missing == 'true' }} + steps: + - name: "if not skip" + run: | + echo "needs.missing-final-newline.outputs.missing-files: ${{ needs.missing-final-newline.outputs.missing-files }}" +``` diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..c30c96f --- /dev/null +++ b/action.yml @@ -0,0 +1,202 @@ +name: github-actions-missing-final-newline +# MEMO: Description must be less than 125 characters. +description: 'A workflow to check missing final newline.' +author: 'hakadoriya' + +branding: + icon: search + color: gray-dark + +inputs: + # + # Common + # + paths: + description: 'A list of substrings of file paths to include written in regular expressions (like on.push.paths)' + required: false + default: '' # empty string + paths-ignore: + description: 'A list of substrings of file paths to ignore written in regular expressions (like on.push.paths-ignore)' + required: false + default: '' # empty string + write: + description: 'Append final newline if missing' + required: false + default: 'false' + skip-checkout: + description: 'If true, skip the checkout step' + required: false + default: 'false' + debug: + description: 'Debug mode' + required: false + default: 'false' + # + # Push event + # ref. # https://docs.github.com/ja/webhooks/webhook-events-and-payloads#push + # + before: + description: 'The commit SHA before the push (push trigger only)' + required: false + default: ${{ github.event.before }} + after: + description: 'The commit SHA after the push (push trigger only)' + required: false + default: ${{ github.event.after }} + # + # Pull request event + # + base-ref: + description: 'The base branch of the repository (pull_request trigger only)' + required: false + default: ${{ github.event.pull_request.base.sha }} + head-ref: + description: 'The head branch of the pull request (pull_request trigger only)' + required: false + default: ${{ github.event.pull_request.head.sha }} + +outputs: + missing: + value: ${{ steps.missing-final-newline.outputs.missing }} + description: "If no missing final newline files, this value is 'true'. Otherwise, this value is 'false'." + missing-files: + value: ${{ steps.missing-final-newline.outputs.missing-files }} + description: "Missing final newline files" + +runs: + using: composite + steps: + - if: ${{ inputs.skip-checkout != 'true' }} + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: github-actions-missing-final-newline + id: missing-final-newline + shell: 'bash' + env: + LOGSH_COLOR: 'true' + run: | + # LICENSE: https://github.com/hakadoriya/log.sh/blob/HEAD/LICENSE + # Common + if [ "${LOGSH_COLOR:-}" ] || [ -t 2 ] ; then LOGSH_COLOR=true; else LOGSH_COLOR=''; fi + _logshRFC3339() { date "+%Y-%m-%dT%H:%M:%S%z" | sed "s/\(..\)$/:\1/"; } + _logshCmd() { for a in "$@"; do if echo "${a:-}" | grep -Eq "[[:blank:]]"; then printf "'%s' " "${a:-}"; else printf "%s " "${a:-}"; fi; done | sed "s/ $//"; } + # Color + LogshDefault() { test " ${LOGSH_LEVEL:-0}" -gt 000 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;35m} DEFAULT${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshDebug() { test " ${LOGSH_LEVEL:-0}" -gt 100 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;34m} DEBUG${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshInfo() { test " ${LOGSH_LEVEL:-0}" -gt 200 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;32m} INFO${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshNotice() { test " ${LOGSH_LEVEL:-0}" -gt 300 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;36m} NOTICE${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshWarn() { test " ${LOGSH_LEVEL:-0}" -gt 400 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;33m} WARN${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshWarning() { test " ${LOGSH_LEVEL:-0}" -gt 400 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;33m} WARNING${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshError() { test " ${LOGSH_LEVEL:-0}" -gt 500 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;31m} ERROR${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshCritical() { test " ${LOGSH_LEVEL:-0}" -gt 600 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;1;31m} CRITICAL${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshAlert() { test " ${LOGSH_LEVEL:-0}" -gt 700 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;41m} ALERT${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshEmergency() { test "${LOGSH_LEVEL:-0}" -gt 800 || echo "$*" | awk "{print \"$(_logshRFC3339) [${LOGSH_COLOR:+\\033[0;1;41m}EMERGENCY${LOGSH_COLOR:+\\033[0m}] \"\$0\"\"}" 1>&2; } + LogshExec() { LogshInfo "$ $(_logshCmd "$@")" && "$@"; } + LogshRun() { _dlm="####R#E#C#D#E#L#I#M#I#T#E#R####" && _all=$({ _out=$("$@") && _rtn=$? || _rtn=$? && printf "\n%s" "${_dlm:?}${_out:-}" && return "${_rtn:-0}"; } 2>&1) && _rtn=$? || _rtn=$? && _dlmno=$(echo "${_all:-}" | sed -n "/${_dlm:?}/=") && _cmd=$(_logshCmd "$@") && _stdout=$(echo "${_all:-}" | tail -n +"${_dlmno:-1}" | sed "s/^${_dlm:?}//") && _stderr=$(echo "${_all:-}" | head -n "${_dlmno:-1}" | grep -v "^${_dlm:?}") && LogshInfo "$ ${_cmd:-}" && LogshInfo "${_stdout:-}" && { [ -z "${_stderr:-}" ] || LogshWarning "${_stderr:?}"; } && return "${_rtn:-0}"; } + # export functions for bash + # shellcheck disable=SC3045 + echo "${SHELL-}" | grep -q "/?bash" && export -f _logshRFC3339 _logshCmd LogshDefault LogshDebug LogshInfo LogshWarning LogshError LogshCritical LogshAlert LogshEmergency LogshExec LogshRun || true + + # + # inputs + # + LogshInfo "----------------------------------------------------------------" + LogshInfo "github:" + LogshInfo " event_name: ${{ github.event_name }}" + LogshInfo " base_ref: ${{ github.base_ref }}" + LogshInfo " head_ref: ${{ github.head_ref }}" + LogshInfo "inputs:" + LogshInfo " before: ${{ inputs.before }}" + LogshInfo " after: ${{ inputs.after }}" + LogshInfo " base-ref: ${{ inputs.base-ref }}" + LogshInfo " head-ref: ${{ inputs.head-ref }}" + LogshInfo "----------------------------------------------------------------" + + # + # main + # + if [[ "${{ github.event_name }}" == 'push' ]]; then + LogshInfo "${{ github.event_name }} event" + before="${{ inputs.before }}" + after="${{ inputs.after }}" + elif [[ "${{ github.event_name }}" == 'pull_request' ]]; then + LogshInfo "${{ github.event_name }} event" + before="${{ inputs.base-ref }}" + after="${{ inputs.head-ref }}" + fi + + LogshDebug "Create paths.txt (without comments and empty lines)" + (grep -v -e "^[[:space:]]*#" -e "^[[:space:]]*$" <<'EOF' | tee paths.txt) || true + ${{ inputs.paths }} + EOF + + LogshDebug "Create paths-ignore.txt (without comments and empty lines)" + (grep -v -e "^[[:space:]]*#" -e "^[[:space:]]*$" <<'EOF' | tee paths-ignore.txt) || true + ${{ inputs.paths-ignore }} + EOF + + if ! files_changed=$(git diff --name-only "${before:?}" "${after:?}"); then + LogshWarn "Failed to get diff files. FORCE CHECK." + files_changed=$(git ls-files) + fi + LogshDebug "==> files_changed <==" + LogshDebug "${files_changed:-(empty)}" + + if [[ -n "${{ inputs.paths }}" ]] && [[ -n "${{ inputs.paths-ignore }}" ]]; then + LogshWarn "Both paths and paths-ignore are set. paths takes precedence." + fi + + if [[ -n "${{ inputs.paths }}" ]]; then + LogshInfo "Apply paths" + files_changed=$(echo "${files_changed:?}" | grep -E -f paths.txt) || true + LogshDebug "==> files_changed (applied paths) <==" + LogshDebug "${files_changed:-(empty)}" + elif [[ -n "${{ inputs.paths-ignore }}" ]]; then + LogshInfo "Apply paths-ignore" + files_changed=$(echo "${files_changed:?}" | grep -Ev -f paths-ignore.txt) || true + LogshDebug "==> files_changed (applied paths-ignore) <==" + LogshDebug "${files_changed:-(empty)}" + else + LogshWarn "paths and paths-ignore are not set." + files_changed=$(echo "${files_changed:?}") + fi + + LogshDebug "Check missing final newline" + while read -r FILE; do + if [[ $(tail -c 1 "${FILE:?}") != $'\n' ]]; then + LogshInfo "Missing final newline: ${FILE:?}" + missing_files="${missing_files:-}${FILE:?}\n" + fi + done <<< "${files_changed:-}" + + if [[ -n "${missing_files:-}" ]]; then + LogshInfo "Missing final newline files" + LogshInfo "${missing_files:?}" + LogshExec echo "missing=true" >> $GITHUB_OUTPUT + LogshExec echo "missing-files=${missing_files:?}" >> $GITHUB_OUTPUT + else + LogshInfo "No missing final newline files" + LogshExec echo "missing=false" >> $GITHUB_OUTPUT + LogshExec echo "missing-files=" >> $GITHUB_OUTPUT + fi + + - name: DEBUG + if: always() && ${{ inputs.debug == 'true' }} + shell: bash + run: | + cat <<'DEBUG_DOC' + == DEBUG ======================================================= + -- inputs ----------------------------------------------------- + before: ${{ inputs.before }} + after: ${{ inputs.after }} + base-ref: ${{ inputs.base-ref }} + head-ref: ${{ inputs.head-ref }} + paths-ignore: ${{ inputs.paths-ignore }} + -- github ----------------------------------------------------- + github.event_name: ${{ github.event_name }} + github.ref: ${{ github.ref }} + -- toJSON(github) ---------------------------------------------- + ${{ toJSON(github) }} + ================================================================ + DEBUG_DOC \ No newline at end of file