From 5fbd8bd18e84e286a07a5b560a67822334636eb2 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Fri, 21 Jun 2024 11:52:48 -0700 Subject: [PATCH 01/10] Use issue templates (#251) This is so I don't have to keep asking the same set of questions when helping people troubleshoot or consider new features/ideas --- .github/ISSUE_TEMPLATE/bug-report.yml | 67 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature-request.yml | 58 +++++++++++++++++++ .github/ISSUE_TEMPLATE/maintainers-only.md | 12 ++++ 4 files changed, 145 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/maintainers-only.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..ef2aa53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,67 @@ +name: Report a problem +description: Create a report to let us help you +body: + - type: textarea + attributes: + label: What events trigger your workflow? + id: ci-triggers + description: >- + Please copy and paste the workflow triggers. + If you are using a resuable workflow (`workflow_dispatch` event), + then please also include the workflow triggers that the calling workflow uses. + placeholder: |- + on: + pull_request: + branches: [main, master, develop] + paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] + push: + branches: [main, master, develop] + paths: ['**.c', '**.cpp', '**.h', '**.hpp', '**.cxx', '**.hxx', '**.cc', '**.hh', '**CMakeLists.txt', 'meson.build', '**.cmake'] + render: yml + validations: + required: true + + - type: textarea + id: runner-os + attributes: + label: What OS does your workflow use? + description: >- + Please tell us what OS the workflow [`runs-on`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). + If you are using an additional [`container`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer), + then please also include that information here. + placeholder: |- + runs-on: ubuntu-latest + container: node:18 + render: yml + validations: + required: true + + - type: textarea + id: cpp-linter-config + attributes: + label: How is cpp-linter-action configured? + description: >- + Please copy and paste the version and inputs used to run cpp-linter-action. + placeholder: |- + - uses: cpp-linter/cpp-linter-action@v2 + id: linter + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + style: 'file' + tidy-checks: '' + render: yml + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: What was the unexpected behavior? + description: >- + Use this area to describe what behavior you expected and what behavior you observed. + Please be clear and concise as possible. Use screenshots if that would help. Most users + use this to paste the workflow logs. + placeholder: You can use markdown syntax here + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8c3ec94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +# this setting will force users to use the provided issue templates +blank_issues_enabled: false +# if the templates provided don't fit the subject of the user feedback, +# here we can give links to other forms of user feedback +contact_links: + - name: cpp-linter discussions + url: https://github.com/orgs/cpp-linter/discussions + about: A place for feedback not specific to cpp-linter-action diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..39a4d77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,58 @@ +--- +name: Feature request +description: Suggest an idea for this project +body: + - type: dropdown + id: existing-feature + attributes: + label: Is your idea related to an existing feature? + description: >- + If this idea is related to an already available feature(s), then please list them here. + multiple: true + options: + - version + - thread-comments + - tidy-checks + - style + - lines-changed-only + - ignore + - tidy-ignore + - format-ignore + - files-changed-only + - file-annotations + - step-summary + - no-lgtm + - tidy-review + - format-review + - passive-reviews + - verbosity + - 'output: checks-failed' + - 'output: clang-tidy-checks-failed' + - 'output: clang-format-checks-failed' + + - type: textarea + id: behavior + attributes: + label: Describe the behavior you would like + description: >- + Use this area to describe what behavior you desire. + Please be clear and concise as possible. Use screenshots if that would help. + placeholder: You can use markdown syntax here + validations: + required: true + + - type: textarea + id: alternative + attributes: + label: Describe alternatives you have considered + description: >- + Were you able to achieve the desired behavior in some other/inconvenient way? + placeholder: You can use markdown syntax here + + - type: textarea + id: added-context + attributes: + label: Additional context + description: >- + If there is anything that might be special or specific to your usage, please let us know. + placeholder: You can use markdown syntax here diff --git a/.github/ISSUE_TEMPLATE/maintainers-only.md b/.github/ISSUE_TEMPLATE/maintainers-only.md new file mode 100644 index 0000000..5a8eea2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/maintainers-only.md @@ -0,0 +1,12 @@ +--- +name: Maintainers' note +about: For ideas related to maintaining the cpp-linter-action source code +title: '' +labels: '' +assignees: '' + +--- + +This issue template is intended only for maintainers of cpp-linter org. + +Only use this issue template if your query is **not** related to a problem or feature. From 704ee3df3d92bf978736ec0bb69f0741789cb496 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Sun, 23 Jun 2024 20:05:51 -0700 Subject: [PATCH 02/10] change offerings for issue templates (#252) ref https://github.com/cpp-linter/cpp-linter-action/pull/251#discussion_r1650264327 --- .github/ISSUE_TEMPLATE/config.yml | 3 +++ .github/ISSUE_TEMPLATE/maintainers-only.md | 12 ------------ 2 files changed, 3 insertions(+), 12 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/maintainers-only.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8c3ec94..ca90cb7 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -6,3 +6,6 @@ contact_links: - name: cpp-linter discussions url: https://github.com/orgs/cpp-linter/discussions about: A place for feedback not specific to cpp-linter-action + - name: Maintainers' note + url: https://github.com/cpp-linter/cpp-linter-action/issues/new + about: Start a discussion for maintainers only diff --git a/.github/ISSUE_TEMPLATE/maintainers-only.md b/.github/ISSUE_TEMPLATE/maintainers-only.md deleted file mode 100644 index 5a8eea2..0000000 --- a/.github/ISSUE_TEMPLATE/maintainers-only.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Maintainers' note -about: For ideas related to maintaining the cpp-linter-action source code -title: '' -labels: '' -assignees: '' - ---- - -This issue template is intended only for maintainers of cpp-linter org. - -Only use this issue template if your query is **not** related to a problem or feature. From 1a1ea41e4c75ad7d2cf857dd86843fad8754674a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 24 Jun 2024 22:56:43 +0800 Subject: [PATCH 03/10] chore: update used-by badge by github-actions[bot] (#248) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 61ccaef..4d73ce2 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=573&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=584&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From c1cb4dc2daf89794decb4aed6e1f4b6895a9a17f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 8 Jul 2024 05:02:21 -0700 Subject: [PATCH 04/10] chore: update used-by badge by github-actions[bot] (#253) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d73ce2..0025573 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=584&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=596&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From f347dee56becc60f063c8b43f95a681805a578e1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Jul 2024 02:18:38 -0700 Subject: [PATCH 05/10] chore: update used-by badge by github-actions[bot] (#254) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0025573..fd35461 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=596&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=603&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From 1e682d44b4ef310f543a62b9b3891aabf50e8dd6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Jul 2024 02:14:53 -0700 Subject: [PATCH 06/10] chore: update used-by badge by github-actions[bot] (#255) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd35461..2a7c202 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=603&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=609&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From 948cea872508ea44123a1e3d8638a5b828a409af Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 29 Jul 2024 02:15:52 -0700 Subject: [PATCH 07/10] chore: update used-by badge by github-actions[bot] (#256) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a7c202..30b6cac 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=609&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=616&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From a37e579de27f4a759c4c5f18f1d43592076236c9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 5 Aug 2024 02:22:45 -0700 Subject: [PATCH 08/10] chore: update used-by badge by github-actions[bot] (#257) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 30b6cac..00be93e 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=616&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=623&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From c735b05bd0c1e9a20b625efb6c611d05a0effa32 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 12 Aug 2024 05:47:11 -0700 Subject: [PATCH 09/10] chore: update used-by badge by github-actions[bot] (#258) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 00be93e..0ce7700 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ # C/C++ Linter Action | clang-format & clang-tidy ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=623&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=627&color=informational&logo=slickpic)](https://github.com/cpp-linter/cpp-linter-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter) [![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml) [![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml) From acd5344307e0a5267de99ebde8dbaecdbc761cfc Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 13 Aug 2024 11:37:52 +0300 Subject: [PATCH 10/10] Bump clang-tools from 0.13.0 to 0.13.1 in the pip group (#259) Bumps the pip group with 1 update: [clang-tools](https://github.com/cpp-linter/clang-tools-pip). Updates `clang-tools` from 0.13.0 to 0.13.1 - [Release notes](https://github.com/cpp-linter/clang-tools-pip/releases) - [Commits](https://github.com/cpp-linter/clang-tools-pip/compare/v0.13.0...v0.13.1) --- updated-dependencies: - dependency-name: clang-tools dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 02917bc..07932df 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ # Install clang-tools binaries (clang-format, clang-tidy) # For details please see: https://github.com/cpp-linter/clang-tools-pip -clang-tools==0.13.0 +clang-tools==0.13.1 # cpp-linter core Python executable package # For details please see: https://github.com/cpp-linter/cpp-linter