From c7a2c8ca744c2aca6b81198bc77cb78595d0f3cc Mon Sep 17 00:00:00 2001 From: ginokent <29125616+ginokent@users.noreply.github.com> Date: Sun, 5 Jan 2025 20:37:21 +0900 Subject: [PATCH] BREAKING CHANGE: transfer repository to hakadoriya organization --- .github/CODEOWNERS | 2 +- .github/dependabot.yml | 17 +- .github/pull_request_template.md | 6 +- .github/workflows/auto-assign.yml | 14 +- .github/workflows/example.yml | 24 +-- .github/workflows/label-checker.yml | 10 +- .github/workflows/task-list-checker.yml | 12 +- .github/workflows/typo-checker.yml | 46 ++++++ LICENSE | 201 ++++++++++++++++++++++++ README.md | 70 ++++----- action.yml | 14 +- 11 files changed, 325 insertions(+), 91 deletions(-) create mode 100644 .github/workflows/typo-checker.yml create mode 100644 LICENSE diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 7611986..1500e3a 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,2 @@ # ref: https://docs.github.com/ja/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners -* @kunitsucom/owners +* @hakadoriya/owner diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 333dbab..4a0ef41 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,13 +1,8 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - version: 2 updates: - - package-ecosystem: "github-actions" # See documentation for possible values - directory: "/" # Location of package manifests + - package-ecosystem: "github-actions" + directory: "/" schedule: interval: "weekly" day: "monday" @@ -16,13 +11,11 @@ updates: commit-message: prefix: "ci(github-actions): " labels: - - "build" - - "dependencies" - - "github_actions" + - "ci" assignees: - - "ginokent" + - "hakadoriya/owner" reviewers: - - "ginokent" + - "hakadoriya/owner" groups: dependencies: patterns: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 33c7a9e..a57dbe8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ > *Please fill in the ticket or issue number.* > > Example: > > -> > #3 +> > #1 ## What's changed @@ -14,11 +14,13 @@ > *Please explain what changes this pull request will make.* > > Example: > > -> > * Added functionality to perform 'bar' on 'foo'. +> > - Added functionality to perform 'bar' on 'foo'. ## Check List - [ ] Assign labels +- [ ] Assign reviewers +- [ ] Assign assignees - [ ] Add appropriate test cases ## Remark diff --git a/.github/workflows/auto-assign.yml b/.github/workflows/auto-assign.yml index 54da72f..5e39f08 100644 --- a/.github/workflows/auto-assign.yml +++ b/.github/workflows/auto-assign.yml @@ -1,5 +1,4 @@ -# ref. https://zenn.dev/snowcait/articles/d6bc5eafd8ab75 -name: 'Auto Assign' +name: auto-assign on: pull_request: @@ -9,16 +8,13 @@ on: - reopened jobs: - assign: - name: Auto Assign - if: github.actor != 'dependabot[bot]' + 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) == '[]' }} - run: gh pr edit "${NUMBER}" --add-assignee "${ASSIGNEE}" env: GH_TOKEN: ${{ github.token }} - GH_REPO: ${{ github.repository }} - NUMBER: ${{ github.event.pull_request.number }} - ASSIGNEE: ${{ github.event.pull_request.user.login }} + 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 index 44584bb..dcfaab5 100644 --- a/.github/workflows/example.yml +++ b/.github/workflows/example.yml @@ -2,19 +2,19 @@ name: example on: push: - # NO paths-ignore + # NO paths filter pull_request: - # NO paths-ignore + # NO paths filter workflow_dispatch: jobs: - paths-ignore: + paths-filter: runs-on: ubuntu-latest outputs: - skip: ${{ steps.paths-ignore.outputs.skip }} + skip: ${{ steps.paths-filter.outputs.skip }} steps: - - uses: kunitsucom/github-actions-paths-ignore-alternative@develop - id: paths-ignore + - uses: hakadoriya/github-actions-paths-filter-alternative@develop + id: paths-filter with: paths: |- # If any of these regular expressions match, it returns skip=false @@ -30,17 +30,17 @@ jobs: # ref. https://docs.github.com/en/actions/using-jobs/using-conditions-to-control-job-execution#overview not-skip: runs-on: ubuntu-latest - needs: paths-ignore - if: ${{ needs.paths-ignore.outputs.skip != 'true' }} + needs: paths-filter + if: ${{ needs.paths-filter.outputs.skip != 'true' }} steps: - name: "if not skip" run: | - echo "needs.paths-ignore.outputs.skip: ${{ needs.paths-ignore.outputs.skip }}" + echo "needs.paths-filter.outputs.skip: ${{ needs.paths-filter.outputs.skip }}" skip: runs-on: ubuntu-latest - needs: paths-ignore - if: ${{ needs.paths-ignore.outputs.skip == 'true' }} + needs: paths-filter + if: ${{ needs.paths-filter.outputs.skip == 'true' }} steps: - name: "if skip" run: | - echo "needs.paths-ignore.outputs.skip: ${{ needs.paths-ignore.outputs.skip }}" + echo "needs.paths-filter.outputs.skip: ${{ needs.paths-filter.outputs.skip }}" diff --git a/.github/workflows/label-checker.yml b/.github/workflows/label-checker.yml index 7e44dd0..7067328 100644 --- a/.github/workflows/label-checker.yml +++ b/.github/workflows/label-checker.yml @@ -1,12 +1,15 @@ name: label-checker -# Dependabot +# # 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 -# Commit prefix +# # 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 @@ -33,8 +36,7 @@ env: LABELS: "BREAKING CHANGE,build,ci,docs,feat,fix,perf,refactor,test,chore" jobs: - check: - name: Check labels + label-checker: runs-on: ubuntu-latest timeout-minutes: 10 permissions: diff --git a/.github/workflows/task-list-checker.yml b/.github/workflows/task-list-checker.yml index 74bcaa0..38f0181 100644 --- a/.github/workflows/task-list-checker.yml +++ b/.github/workflows/task-list-checker.yml @@ -10,20 +10,14 @@ on: - synchronize jobs: - check: - name: Check task list + task-list-checker: + if: github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]' runs-on: ubuntu-latest timeout-minutes: 10 permissions: - id-token: write contents: read pull-requests: read - statuses: write - defaults: - run: - shell: bash steps: - - name: Check for incomplete task list items - uses: Shopify/task-list-checker@7cab3e5a969a34f8c553974bc6f8940d8c3978de # ref. https://github.com/Shopify/task-list-checker + - 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 index 9c2499c..951dcf0 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,54 @@ -# GitHub Actions `paths-ignore` Alternative +# GitHub Actions `paths` Filter Alternative -A workaround workflow to resolve the incompatibility of the `Require status checks to pass` setting when `paths-ignore` is set for push trigger or pull_request trigger in GitHub Actions. +A workaround workflow to resolve the incompatibility of the `Require status checks to pass` setting when `paths` filter is set for push trigger or pull_request trigger in GitHub Actions. -## `paths-ignore` example +## `paths` example ```yml name: example on: push: - # NO paths-ignore + # NO paths filter pull_request: - # NO paths-ignore + # NO paths filter workflow_dispatch: jobs: - paths-ignore: + paths-filter: runs-on: ubuntu-latest outputs: - skip: ${{ steps.paths-ignore.outputs.skip }} + skip: ${{ steps.paths-filter.outputs.skip }} steps: - - uses: kunitsucom/github-actions-paths-ignore-alternative@main - id: paths-ignore + - uses: hakadoriya/github-actions-paths-filter-alternative@main + id: paths-filter with: - paths-ignore: |- - # substrings of file paths to ignore written in regular expressions - ^.github/ - ^.*\.md$ - ^.*\.log$ + paths: |- + # If any of these regular expressions match, it returns skip=false + # This setting takes precedence over paths-ignore + ^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 not-skip: runs-on: ubuntu-latest - needs: paths-ignore - if: ${{ needs.paths-ignore.outputs.skip != 'true' }} + needs: paths-filter + if: ${{ needs.paths-filter.outputs.skip != 'true' }} steps: - name: "if not skip" run: | - echo "needs.paths-ignore.outputs.skip: ${{ needs.paths-ignore.outputs.skip }}" + echo "needs.paths-filter.outputs.skip: ${{ needs.paths-filter.outputs.skip }}" skip: runs-on: ubuntu-latest - needs: paths-ignore - if: ${{ needs.paths-ignore.outputs.skip == 'true' }} + needs: paths-filter + if: ${{ needs.paths-filter.outputs.skip == 'true' }} steps: - name: "if skip" run: | - echo "needs.paths-ignore.outputs.skip: ${{ needs.paths-ignore.outputs.skip }}" + echo "needs.paths-filter.outputs.skip: ${{ needs.paths-filter.outputs.skip }}" ``` -## `paths` example +## `paths-ignore` example ```yml name: example @@ -62,35 +61,36 @@ on: workflow_dispatch: jobs: - paths-ignore: + paths-filter: runs-on: ubuntu-latest outputs: - skip: ${{ steps.paths-ignore.outputs.skip }} + skip: ${{ steps.paths-filter.outputs.skip }} steps: - - uses: kunitsucom/github-actions-paths-ignore-alternative@main - id: paths-ignore + - uses: hakadoriya/github-actions-paths-filter-alternative@main + id: paths-filter with: - paths: |- - # If any of these regular expressions match, it returns skip=false - # This setting takes precedence over paths-ignore - ^action.yml + paths-ignore: |- + # substrings of file paths to ignore written in regular expressions + ^.github/ + ^.*\.md$ + ^.*\.log$ # > 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 not-skip: runs-on: ubuntu-latest - needs: paths-ignore - if: ${{ needs.paths-ignore.outputs.skip != 'true' }} + needs: paths-filter + if: ${{ needs.paths-filter.outputs.skip != 'true' }} steps: - name: "if not skip" run: | - echo "needs.paths-ignore.outputs.skip: ${{ needs.paths-ignore.outputs.skip }}" + echo "needs.paths-filter.outputs.skip: ${{ needs.paths-filter.outputs.skip }}" skip: runs-on: ubuntu-latest - needs: paths-ignore - if: ${{ needs.paths-ignore.outputs.skip == 'true' }} + needs: paths-filter + if: ${{ needs.paths-filter.outputs.skip == 'true' }} steps: - name: "if skip" run: | - echo "needs.paths-ignore.outputs.skip: ${{ needs.paths-ignore.outputs.skip }}" + echo "needs.paths-filter.outputs.skip: ${{ needs.paths-filter.outputs.skip }}" ``` diff --git a/action.yml b/action.yml index 194807a..a06d5cd 100644 --- a/action.yml +++ b/action.yml @@ -1,7 +1,7 @@ -name: github-actions-paths-ignore-alternative +name: github-actions-paths-filter-alternative # MEMO: Description must be less than 125 characters. -description: 'A workaround workflow to resolve the incompatibility of `Require status checks to pass` setting when `paths-ignore` is set.' -author: 'kunitsucom' +description: 'A workaround workflow to resolve the incompatibility of `Require status checks to pass` setting when `paths` filter is set.' +author: 'hakadoriya' branding: icon: search @@ -53,7 +53,7 @@ inputs: outputs: skip: - value: ${{ steps.paths-ignore.outputs.skip }} + value: ${{ steps.paths-filter.outputs.skip }} description: "If no diff, this value is 'true'. Otherwise, this value is 'false'." runs: @@ -63,13 +63,13 @@ runs: uses: actions/checkout@v4 with: fetch-depth: 0 - - name: github-actions-paths-ignore-alternative - id: paths-ignore + - name: github-actions-paths-filter-alternative + id: paths-filter shell: 'bash' env: LOGSH_COLOR: 'true' run: | - # LICENSE: https://github.com/kunitsucom/log.sh/blob/HEAD/LICENSE + # 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/"; }