From e43f6f6a521360322f65c82a5534d9da14566c28 Mon Sep 17 00:00:00 2001 From: kumvijaya Date: Fri, 24 May 2024 01:03:47 +0530 Subject: [PATCH] T6386: added reusable workflows and codeowners --- .github/PULL_REQUEST_TEMPLATE.md | 6 +-- .github/labeler.yml | 12 ----- .github/reviewers.yml | 3 -- .github/workflows/add-pr-labels.yml | 18 +++++++ .github/workflows/auto-author-assign.yml | 21 ++------ .github/workflows/chceck-pr-message.yml | 18 +++++++ .github/workflows/check-pr-conflicts.yml | 14 +++++ .github/workflows/check-stale.yml | 14 +++++ .github/workflows/check-unused-imports.yml | 16 ++++++ .github/workflows/codeql.yml | 23 ++++++++ .github/workflows/label-backport.yml | 12 +++++ .github/workflows/linit-j2.yml | 19 +++++++ .github/workflows/pr-conflicts.yml | 18 ------- .github/workflows/pull-request-labels.yml | 20 ------- CODEOWNERS | 1 + scripts/check-pr-title-and-commit-messages.py | 54 ------------------- 16 files changed, 142 insertions(+), 127 deletions(-) delete mode 100644 .github/labeler.yml delete mode 100644 .github/reviewers.yml create mode 100644 .github/workflows/add-pr-labels.yml create mode 100644 .github/workflows/chceck-pr-message.yml create mode 100644 .github/workflows/check-pr-conflicts.yml create mode 100644 .github/workflows/check-stale.yml create mode 100644 .github/workflows/check-unused-imports.yml create mode 100644 .github/workflows/codeql.yml create mode 100644 .github/workflows/label-backport.yml create mode 100644 .github/workflows/linit-j2.yml delete mode 100644 .github/workflows/pr-conflicts.yml delete mode 100644 .github/workflows/pull-request-labels.yml create mode 100644 CODEOWNERS delete mode 100755 scripts/check-pr-title-and-commit-messages.py diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 87eee2e779..8c71c80d88 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,8 +18,8 @@ the box, please use [x] - [ ] Other (please describe): ## Related Task(s) - -* https://vyos.dev/Txxxx + + ## Component(s) name @@ -41,7 +41,7 @@ like this -- [ ] I have read the [**CONTRIBUTING**](https://github.com/vyos/vyos-1x/blob/current/CONTRIBUTING.md) document +- [ ] I have read the [**CONTRIBUTING**](https://github.com/vyos/vyos-build/blob/current/CONTRIBUTING.md) document - [ ] I have linked this PR to one or more Phabricator Task(s) - [ ] My commit headlines contain a valid Task id - [ ] My change requires a change to the documentation diff --git a/.github/labeler.yml b/.github/labeler.yml deleted file mode 100644 index e0b9ee4309..0000000000 --- a/.github/labeler.yml +++ /dev/null @@ -1,12 +0,0 @@ -equuleus: - - any: - - base-branch: 'equuleus' -current: - - any: - - base-branch: 'current' -crux: - - any: - - base-branch: 'crux' -sagitta: - - any: - - base-branch: 'sagitta' diff --git a/.github/reviewers.yml b/.github/reviewers.yml deleted file mode 100644 index a1647d20d8..0000000000 --- a/.github/reviewers.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -"**/*": - - team: reviewers diff --git a/.github/workflows/add-pr-labels.yml b/.github/workflows/add-pr-labels.yml new file mode 100644 index 0000000000..ffb04f33b0 --- /dev/null +++ b/.github/workflows/add-pr-labels.yml @@ -0,0 +1,18 @@ +--- +name: Add pull request labels + +on: + pull_request_target: + branches: + - current + - equuleus + - sagitta + +permissions: + pull-requests: write + contents: read + +jobs: + add-pr-label: + uses: vyos/.github/.github/workflows/add-pr-labels.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/auto-author-assign.yml b/.github/workflows/auto-author-assign.yml index 13bfd9bb14..c3696ea476 100644 --- a/.github/workflows/auto-author-assign.yml +++ b/.github/workflows/auto-author-assign.yml @@ -3,25 +3,12 @@ on: pull_request_target: types: [opened, reopened, ready_for_review, locked] + permissions: pull-requests: write + contents: read jobs: - # https://github.com/marketplace/actions/auto-author-assign assign-author: - runs-on: ubuntu-latest - steps: - - name: "Assign Author to PR" - uses: toshimaru/auto-author-assign@v1.3.5 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - - # https://github.com/shufo/auto-assign-reviewer-by-files - assign_reviewer: - runs-on: ubuntu-latest - steps: - - name: Request review based on files changes and/or groups the author belongs to - uses: shufo/auto-assign-reviewer-by-files@v1.1.4 - with: - token: ${{ secrets.PR_ACTION_ASSIGN_REVIEWERS }} - config: .github/reviewers.yml + uses: vyos/.github/.github/workflows/assign-author.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/chceck-pr-message.yml b/.github/workflows/chceck-pr-message.yml new file mode 100644 index 0000000000..f4d30b289c --- /dev/null +++ b/.github/workflows/chceck-pr-message.yml @@ -0,0 +1,18 @@ +--- +name: Check pull request message format + +on: + pull_request: + branches: + - current + - sagitta + - equuleus + +permissions: + pull-requests: write + contents: read + +jobs: + check-pr-title: + uses: vyos/.github/.github/workflows/check-pr-message.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/check-pr-conflicts.yml b/.github/workflows/check-pr-conflicts.yml new file mode 100644 index 0000000000..0c659e6ed9 --- /dev/null +++ b/.github/workflows/check-pr-conflicts.yml @@ -0,0 +1,14 @@ + +name: "PR Conflicts checker" +on: + pull_request_target: + types: [synchronize] + +permissions: + pull-requests: write + contents: read + +jobs: + check-pr-conflict-call: + uses: vyos/.github/.github/workflows/check-pr-merge-conflict.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/check-stale.yml b/.github/workflows/check-stale.yml new file mode 100644 index 0000000000..59d25a11b6 --- /dev/null +++ b/.github/workflows/check-stale.yml @@ -0,0 +1,14 @@ +name: "Issue and PR stale management" +on: + schedule: + - cron: "0 0 * * *" + workflow_dispatch: + +permissions: + pull-requests: write + contents: read + +jobs: + stale: + uses: vyos/.github/.github/workflows/check-stale.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/check-unused-imports.yml b/.github/workflows/check-unused-imports.yml new file mode 100644 index 0000000000..324a63e902 --- /dev/null +++ b/.github/workflows/check-unused-imports.yml @@ -0,0 +1,16 @@ +name: Check for unused imports using Pylint +on: + pull_request: + branches: + - current + - sagitta + - equuleus + workflow_dispatch: + +permissions: + contents: read + +jobs: + check-unused-imports: + uses: vyos/.github/.github/workflows/check-unused-imports.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000000..a4fc39e263 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,23 @@ +name: "Perform CodeQL Analysis" + +on: + push: + branches: [ "current", "sagitta", "equuleus" ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ "current" ] + schedule: + - cron: '22 10 * * 0' + workflow_dispatch: + +permissions: + actions: read + contents: read + security-events: write + +jobs: + codeql-analysis-call: + uses: vyos/.github/.github/workflows/codeql-analysis.yml@feature/T6349-reusable-workflows + secrets: inherit + with: + languages: "['python']" diff --git a/.github/workflows/label-backport.yml b/.github/workflows/label-backport.yml new file mode 100644 index 0000000000..9192b81843 --- /dev/null +++ b/.github/workflows/label-backport.yml @@ -0,0 +1,12 @@ +name: Mergifyio backport + +on: [issue_comment] + +permissions: + pull-requests: write + contents: read + +jobs: + mergifyio-backport: + uses: vyos/.github/.github/workflows/label-backport.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/linit-j2.yml b/.github/workflows/linit-j2.yml new file mode 100644 index 0000000000..95bfa61f01 --- /dev/null +++ b/.github/workflows/linit-j2.yml @@ -0,0 +1,19 @@ +--- +name: J2 Lint + +on: + pull_request: + branches: + - current + - sagitta + - equuleus + workflow_dispatch: + +permissions: + pull-requests: write + contents: read + +jobs: + j2lint: + uses: vyos/.github/.github/workflows/lint-j2.yml@feature/T6349-reusable-workflows + secrets: inherit diff --git a/.github/workflows/pr-conflicts.yml b/.github/workflows/pr-conflicts.yml deleted file mode 100644 index 2fd0bb42d1..0000000000 --- a/.github/workflows/pr-conflicts.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: "PR Conflicts checker" -on: - pull_request_target: - types: [synchronize] - -jobs: - Conflict_Check: - name: 'Check PR status: conflicts and resolution' - runs-on: ubuntu-latest - steps: - - name: check if PRs are dirty - uses: eps1lon/actions-label-merge-conflict@v3 - with: - dirtyLabel: "state: conflict" - removeOnDirtyLabel: "state: conflict resolved" - repoToken: "${{ secrets.GITHUB_TOKEN }}" - commentOnDirty: "This pull request has conflicts, please resolve those before we can evaluate the pull request." - commentOnClean: "Conflicts have been resolved. A maintainer will review the pull request shortly." diff --git a/.github/workflows/pull-request-labels.yml b/.github/workflows/pull-request-labels.yml deleted file mode 100644 index 3398af5b0f..0000000000 --- a/.github/workflows/pull-request-labels.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Add pull request labels - -on: - pull_request_target: - branches: - - current - - crux - - equuleus - - sagitta - -jobs: - add-pr-label: - name: Add PR Labels - runs-on: ubuntu-20.04 - permissions: - contents: read - pull-requests: write - steps: - - uses: actions/labeler@v5.0.0 diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000000..1b3e518b36 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @kumvijaya \ No newline at end of file diff --git a/scripts/check-pr-title-and-commit-messages.py b/scripts/check-pr-title-and-commit-messages.py deleted file mode 100755 index 8fe3ca791c..0000000000 --- a/scripts/check-pr-title-and-commit-messages.py +++ /dev/null @@ -1,54 +0,0 @@ -#!/usr/bin/env python3 - -import re -import sys -import time - -import requests - -# Use the same regex for PR title and commit messages for now -title_regex = r'^(([a-zA-Z\-_.]+:\s)?)T\d+:\s+[^\s]+.*' -commit_regex = title_regex - - -def check_pr_title(title): - if not re.match(title_regex, title): - print(f"PR title '{title}' does not match the required format!") - print("Valid title example: T99999: make IPsec secure") - sys.exit(1) - - -def check_commit_message(title): - if not re.match(commit_regex, title): - print("Commit title '{title}' does not match the required format!") - print("Valid title example: T99999: make IPsec secure") - sys.exit(1) - - -if __name__ == '__main__': - if len(sys.argv) < 2: - print("Please specify pull request URL!") - sys.exit(1) - - # There seems to be a race condition that causes this scripts to receive - # an incomplete PR object that is missing certain fields, - # which causes temporary CI failures that require re-running the script - # - # It's probably better to add a small delay to prevent that - time.sleep(5) - - # Get the pull request object - pr = requests.get(sys.argv[1]).json() - if "title" not in pr: - print("The PR object does not have a title field!") - print("Did not receive a valid pull request object, please check the URL!") - sys.exit(1) - - check_pr_title(pr["title"]) - - # Get the list of commits - commits = requests.get(pr["commits_url"]).json() - for c in commits: - # Retrieve every individual commit and check its title - co = requests.get(c["url"]).json() - check_commit_message(co["commit"]["message"])