From 403c1d86765ad6b42d23b5255ac59f26a1f496e0 Mon Sep 17 00:00:00 2001 From: Simon Sawert Date: Tue, 2 Jul 2024 22:02:31 +0200 Subject: [PATCH 1/3] Add action to add checklist for new linter This will add the checklist for new linters to the repository and revision control. When the label `linter: new` is added the checklist will automatically be added to the PR instead of having to copy-paste it from an arbitrary source. Since only collaborators and members can add labels it's not likely that this will be abused, however to mitigate the risk even further the action will reset the checklist comment if the tag is added and removed multiple times. --- .github/workflows/new_linter_checklist.yaml | 105 ++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 .github/workflows/new_linter_checklist.yaml diff --git a/.github/workflows/new_linter_checklist.yaml b/.github/workflows/new_linter_checklist.yaml new file mode 100644 index 000000000000..bea50b1a96eb --- /dev/null +++ b/.github/workflows/new_linter_checklist.yaml @@ -0,0 +1,105 @@ +--- +name: Add new linter checklist +on: + pull_request: + types: + - labeled + +jobs: + add-comment: + if: "github.event.label.name == 'linter: new'" + runs-on: ubuntu-latest + permissions: + pull-requests: write + + steps: + - name: Add checklist + run: | + # This is just safety to not spam with new comments if the tag is + # removed and added back multiple times maliciously. It will reset the + # checklist but the previous values will be in the edit history. + comment_exist=$(gh pr view "$NUMBER" \ + --json comments \ + --jq '.comments[].author | select(.login=="github-actions") | .login' \ + | wc -l) + [ "$comment_exist" -gt 0 ] && edit_last="--edit-last" + + # Comment on the PR with the checklist. + gh pr comment "$NUMBER" --body "$BODY" $edit_last + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_REPO: ${{ github.repository }} + NUMBER: ${{ github.event.number }} + BODY: | + In order for a pull request adding a linter to be reviewed, the linter and the PR must follow some requirements. + + - [ ] The CLA must be signed + + ### Pull Request Description + + - [ ] It must have a link to the linter repository. + - [ ] It must provide a short description of the linter. + + ### Linter + + - [ ] It must not be a duplicate of another linter or a rule of a linter. (the team will help to verify that) + - [ ] It must have a valid license (AGPL is not allowed) and the file must contain the required information by the license, ex: author, year, etc. + - [ ] The linter repository must have a CI and tests. + - [ ] It must use [`go/analysis`](https://golangci-lint.run/contributing/new-linters/). + - [ ] It must have a valid tag, ex: `v1.0.0`, `v0.1.0`. + - [ ] It must not contain `init()`. + - [ ] It must not contain `panic()`. + - [ ] It must not contain `log.fatal()`, `os.exit()`, or similar. + - [ ] It must not modify the AST. + - [ ] It must not have false positives/negatives. (the team will help to verify that) + - [ ] It must have tests inside golangci-lint. + + ### The Linter Tests Inside Golangci-lint + + - [ ] They must have at least one std lib import. + - [ ] They must have integration tests without configuration (default). + - [ ] They must have integration tests with configuration (if the linter has a configuration). + + ### `.golangci.next.reference.yml` + + - [ ] The file `.golangci.next.reference.yml` must be updated. + - [ ] The file `.golangci.reference.yml` must NOT be edited. + - [ ] The linter must be added to the lists of available linters (alphabetical case-insensitive order). + - `enable` and `disable` options + - [ ] If the linter has a configuration, the exhaustive configuration of the linter must be added (alphabetical case-insensitive order) + - The values must be different from the default ones. + - The default values must be defined in a comment. + - The option must have a short description. + + ### Others Requirements + + - [ ] The files (tests and linter) inside golangci-lint must have the same name as the linter. + - [ ] The `.golangci.yml` of golangci-lint itself must not be edited and the linter must not be added to this file. + - [ ] The linters must be sorted in the alphabetical order (case-insensitive) in the `lintersdb/builder_linter.go` and `.golangci.next.reference.yml`. + - [ ] The load mode (`WithLoadMode(...)`): + - if the linter uses `goanalysis.LoadModeSyntax` -> no `WithLoadForGoAnalysis()` in `lintersdb/builder_linter.go` + - if the linter uses `goanalysis.LoadModeTypesInfo`, it requires `WithLoadForGoAnalysis()` in `lintersdb/builder_linter.go` + - [ ] The version in `WithSince(...)` must be the next minor version (`v1.X.0`) of golangci-lint. + - [ ] `WithURL()` must contain the URL of the repository. + - [ ] The linter must use go1.21 + + ### Recommendations + + - [ ] The file `jsonschema/golangci.next.jsonschema.json` should be updated. + - [ ] The file `jsonschema/golangci.jsonschema.json` must NOT be edited. + - [ ] The linter repository should have a readme and linting. + - [ ] The linter should be published as a binary. (useful to diagnose bug origins) + - [ ] The linter repository should have a `.gitignore` (IDE files, binaries, OS files, etc. should not be committed) + - [ ] A tag should never be recreated. + + --- + + The golangci-lint team will edit this comment to check the boxes before and during the review. + + The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify). + + The reviews should be addressed as commits (no squash). + + If the author of the PR is a member of the golangci-lint team, he should not edit this message. + + **This checklist does not imply that we will accept the linter.** From 71ed8050974efbc8753eae9d9f18c4ce015b8581 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Wed, 3 Jul 2024 15:34:22 +0200 Subject: [PATCH 2/3] review: workflow_dispatch --- .github/new-linter-checklist.md | 72 ++++++++++++++ .github/workflows/new-linter-checklist.yaml | 35 +++++++ .github/workflows/new_linter_checklist.yaml | 105 -------------------- 3 files changed, 107 insertions(+), 105 deletions(-) create mode 100644 .github/new-linter-checklist.md create mode 100644 .github/workflows/new-linter-checklist.yaml delete mode 100644 .github/workflows/new_linter_checklist.yaml diff --git a/.github/new-linter-checklist.md b/.github/new-linter-checklist.md new file mode 100644 index 000000000000..1fa0c590da52 --- /dev/null +++ b/.github/new-linter-checklist.md @@ -0,0 +1,72 @@ +In order for a pull request adding a linter to be reviewed, the linter and the PR must follow some requirements. + +- [ ] The CLA must be signed + +### Pull Request Description + +- [ ] It must have a link to the linter repository. +- [ ] It must provide a short description of the linter. + +### Linter + +- [ ] It must not be a duplicate of another linter or a rule of a linter. (the team will help to verify that) +- [ ] It must have a valid license (AGPL is not allowed) and the file must contain the required information by the license, ex: author, year, etc. +- [ ] It must use Go <= 1.21 +- [ ] The linter repository must have a CI and tests. +- [ ] It must use [`go/analysis`](https://golangci-lint.run/contributing/new-linters/). +- [ ] It must have a valid tag, ex: `v1.0.0`, `v0.1.0`. +- [ ] It must not contain `init()`. +- [ ] It must not contain `panic()`. +- [ ] It must not contain `log.fatal()`, `os.exit()`, or similar. +- [ ] It must not modify the AST. +- [ ] It must not have false positives/negatives. (the team will help to verify that) +- [ ] It must have tests inside golangci-lint. + +### The Linter Tests Inside Golangci-lint + +- [ ] They must have at least one std lib import. +- [ ] They must have integration tests without configuration (default). +- [ ] They must have integration tests with configuration (if the linter has a configuration). + +### `.golangci.next.reference.yml` + +- [ ] The file `.golangci.next.reference.yml` must be updated. +- [ ] The file `.golangci.reference.yml` must NOT be edited. +- [ ] The linter must be added to the lists of available linters (alphabetical case-insensitive order). + - `enable` and `disable` options +- [ ] If the linter has a configuration, the exhaustive configuration of the linter must be added (alphabetical case-insensitive order) + - The values must be different from the default ones. + - The default values must be defined in a comment. + - The option must have a short description. + +### Others Requirements + +- [ ] The files (tests and linter) inside golangci-lint must have the same name as the linter. +- [ ] The `.golangci.yml` of golangci-lint itself must not be edited and the linter must not be added to this file. +- [ ] The linters must be sorted in the alphabetical order (case-insensitive) in the `lintersdb/builder_linter.go` and `.golangci.next.reference.yml`. +- [ ] The load mode (`WithLoadMode(...)`): + - if the linter uses `goanalysis.LoadModeSyntax` -> no `WithLoadForGoAnalysis()` in `lintersdb/builder_linter.go` + - if the linter uses `goanalysis.LoadModeTypesInfo`, it requires `WithLoadForGoAnalysis()` in `lintersdb/builder_linter.go` +- [ ] The version in `WithSince(...)` must be the next minor version (`v1.X.0`) of golangci-lint. +- [ ] `WithURL()` must contain the URL of the repository. + +### Recommendations + +- [ ] The file `jsonschema/golangci.next.jsonschema.json` should be updated. +- [ ] The file `jsonschema/golangci.jsonschema.json` must NOT be edited. +- [ ] The linter repository should have a readme and linting. +- [ ] The linter should be published as a binary. (useful to diagnose bug origins) +- [ ] The linter repository should have a `.gitignore` (IDE files, binaries, OS files, etc. should not be committed) +- [ ] A tag should never be recreated. + +--- + +The golangci-lint team will edit this comment to check the boxes before and during the review. + +The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify). + +The reviews should be addressed as commits (no squash). + +If the author of the PR is a member of the golangci-lint team, he should not edit this message. + +**This checklist does not imply that we will accept the linter.** diff --git a/.github/workflows/new-linter-checklist.yaml b/.github/workflows/new-linter-checklist.yaml new file mode 100644 index 000000000000..89efa00731e6 --- /dev/null +++ b/.github/workflows/new-linter-checklist.yaml @@ -0,0 +1,35 @@ +name: Add new linter checklist + +on: + workflow_dispatch: + inputs: + pr: + description: PR number + required: true + type: number + +permissions: + pull-requests: write + +jobs: + add-comment: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Add checklist + run: | + # This is just safety to not spam with new comments if the tag is + # removed and added back multiple times maliciously. It will reset the + # checklist but the previous values will be in the edit history. + comment_exist=$(gh pr view "$NUMBER" \ + --json comments \ + --jq '.comments[].author | select(.login=="github-actions") | .login' \ + | wc -l) + [ "$comment_exist" -gt 0 ] && edit_last="--edit-last" + + # Comment on the PR with the checklist. + gh pr comment "$NUMBER" --body "$(cat .github/new-linter-checklist.md)" $edit_last + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_REPO: ${{ github.repository }} + NUMBER: ${{ inputs.pr }} diff --git a/.github/workflows/new_linter_checklist.yaml b/.github/workflows/new_linter_checklist.yaml deleted file mode 100644 index bea50b1a96eb..000000000000 --- a/.github/workflows/new_linter_checklist.yaml +++ /dev/null @@ -1,105 +0,0 @@ ---- -name: Add new linter checklist -on: - pull_request: - types: - - labeled - -jobs: - add-comment: - if: "github.event.label.name == 'linter: new'" - runs-on: ubuntu-latest - permissions: - pull-requests: write - - steps: - - name: Add checklist - run: | - # This is just safety to not spam with new comments if the tag is - # removed and added back multiple times maliciously. It will reset the - # checklist but the previous values will be in the edit history. - comment_exist=$(gh pr view "$NUMBER" \ - --json comments \ - --jq '.comments[].author | select(.login=="github-actions") | .login' \ - | wc -l) - [ "$comment_exist" -gt 0 ] && edit_last="--edit-last" - - # Comment on the PR with the checklist. - gh pr comment "$NUMBER" --body "$BODY" $edit_last - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - GH_REPO: ${{ github.repository }} - NUMBER: ${{ github.event.number }} - BODY: | - In order for a pull request adding a linter to be reviewed, the linter and the PR must follow some requirements. - - - [ ] The CLA must be signed - - ### Pull Request Description - - - [ ] It must have a link to the linter repository. - - [ ] It must provide a short description of the linter. - - ### Linter - - - [ ] It must not be a duplicate of another linter or a rule of a linter. (the team will help to verify that) - - [ ] It must have a valid license (AGPL is not allowed) and the file must contain the required information by the license, ex: author, year, etc. - - [ ] The linter repository must have a CI and tests. - - [ ] It must use [`go/analysis`](https://golangci-lint.run/contributing/new-linters/). - - [ ] It must have a valid tag, ex: `v1.0.0`, `v0.1.0`. - - [ ] It must not contain `init()`. - - [ ] It must not contain `panic()`. - - [ ] It must not contain `log.fatal()`, `os.exit()`, or similar. - - [ ] It must not modify the AST. - - [ ] It must not have false positives/negatives. (the team will help to verify that) - - [ ] It must have tests inside golangci-lint. - - ### The Linter Tests Inside Golangci-lint - - - [ ] They must have at least one std lib import. - - [ ] They must have integration tests without configuration (default). - - [ ] They must have integration tests with configuration (if the linter has a configuration). - - ### `.golangci.next.reference.yml` - - - [ ] The file `.golangci.next.reference.yml` must be updated. - - [ ] The file `.golangci.reference.yml` must NOT be edited. - - [ ] The linter must be added to the lists of available linters (alphabetical case-insensitive order). - - `enable` and `disable` options - - [ ] If the linter has a configuration, the exhaustive configuration of the linter must be added (alphabetical case-insensitive order) - - The values must be different from the default ones. - - The default values must be defined in a comment. - - The option must have a short description. - - ### Others Requirements - - - [ ] The files (tests and linter) inside golangci-lint must have the same name as the linter. - - [ ] The `.golangci.yml` of golangci-lint itself must not be edited and the linter must not be added to this file. - - [ ] The linters must be sorted in the alphabetical order (case-insensitive) in the `lintersdb/builder_linter.go` and `.golangci.next.reference.yml`. - - [ ] The load mode (`WithLoadMode(...)`): - - if the linter uses `goanalysis.LoadModeSyntax` -> no `WithLoadForGoAnalysis()` in `lintersdb/builder_linter.go` - - if the linter uses `goanalysis.LoadModeTypesInfo`, it requires `WithLoadForGoAnalysis()` in `lintersdb/builder_linter.go` - - [ ] The version in `WithSince(...)` must be the next minor version (`v1.X.0`) of golangci-lint. - - [ ] `WithURL()` must contain the URL of the repository. - - [ ] The linter must use go1.21 - - ### Recommendations - - - [ ] The file `jsonschema/golangci.next.jsonschema.json` should be updated. - - [ ] The file `jsonschema/golangci.jsonschema.json` must NOT be edited. - - [ ] The linter repository should have a readme and linting. - - [ ] The linter should be published as a binary. (useful to diagnose bug origins) - - [ ] The linter repository should have a `.gitignore` (IDE files, binaries, OS files, etc. should not be committed) - - [ ] A tag should never be recreated. - - --- - - The golangci-lint team will edit this comment to check the boxes before and during the review. - - The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify). - - The reviews should be addressed as commits (no squash). - - If the author of the PR is a member of the golangci-lint team, he should not edit this message. - - **This checklist does not imply that we will accept the linter.** From 7d982dfb294164939ac9a2152f5f0bf08c03ffbc Mon Sep 17 00:00:00 2001 From: Simon Sawert Date: Wed, 3 Jul 2024 20:58:43 +0200 Subject: [PATCH 3/3] Update comments in action --- .github/workflows/new-linter-checklist.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/new-linter-checklist.yaml b/.github/workflows/new-linter-checklist.yaml index 89efa00731e6..d472c960d1a9 100644 --- a/.github/workflows/new-linter-checklist.yaml +++ b/.github/workflows/new-linter-checklist.yaml @@ -18,16 +18,13 @@ jobs: - uses: actions/checkout@v4 - name: Add checklist run: | - # This is just safety to not spam with new comments if the tag is - # removed and added back multiple times maliciously. It will reset the - # checklist but the previous values will be in the edit history. + # Avoid adding multiple comments for the same PR. comment_exist=$(gh pr view "$NUMBER" \ --json comments \ --jq '.comments[].author | select(.login=="github-actions") | .login' \ | wc -l) [ "$comment_exist" -gt 0 ] && edit_last="--edit-last" - # Comment on the PR with the checklist. gh pr comment "$NUMBER" --body "$(cat .github/new-linter-checklist.md)" $edit_last env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}