Merge pull request #772 from instructlab/fix-dependabot-and-mergify-configs

fix: Mergify and Dependabot configs YAML are incorrect/inconsistent

Author: vishnoianil

.github/dependabot.yml

@@ -63,9 +63,19 @@ updates:
     target-branch: "main"
     labels:
       - "docker dependencies"
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "instructlab/ui-maintainers"
+    groups:
+      python-packages:
+        patterns:
+          - "*"
 
   # Enable version updates for the following package ecosystems for release-1.0 branch
-    - package-ecosystem: "npm"
+  - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "weekly"
@@ -129,7 +139,7 @@ updates:
       - "docker dependencies"
 
   # Enable version updates for the following package ecosystems for release-1.2 branch
-    - package-ecosystem: "npm"
+  - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "weekly"
@@ -191,3 +201,13 @@ updates:
     target-branch: "release-1.2"
     labels:
       - "docker dependencies"
+  - package-ecosystem: pip
+    directory: "/api-server/qna-eval"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "instructlab/ui-maintainers"
+    groups:
+      python-packages:
+        patterns:
+          - "*"

.github/mergify.yml

@@ -1,40 +1,42 @@
 pull_request_rules:
-- name: dependabot-auto-merge
-  description: Automatically merge dependabot PRs that pass CI
-  conditions:
-    - author=dependabot[bot]
-    - check-success=golangci-lint-worker
-    - check-success=golangci-lint-bot
-    - check-success=ansible
-    - check-success=Shellcheck
-    - check-success=markdown-lint
-    - check-success=DCO
-    - label!=hold
-  actions:
-    merge:
-      method: merge
+  - name: dependabot-auto-merge
+    description: Automatically merge dependabot PRs that pass CI
+    conditions:
+      - author=dependabot[bot]
+      - check-success=golangci-lint-worker
+      - check-success=golangci-lint-bot
+      - check-success=ansible
+      - check-success=Shellcheck
+      - check-success=markdown-lint
+      - check-success=DCO
+      - label!=hold
+    actions:
+      merge:
+        method: merge
 
-- name: auto-merge
-  description: automatic merge for main with > 1 approved reviews, all requested reviews have given feedback, not held, and CI is successful
-  conditions:
-    - "#approved-reviews-by>=1"
-    - "#review-requested=0"
-    - "#changes-requested-reviews-by=0"
-    - base=main
-    - label!=hold
-    - check-success=golangci-lint-worker
-    - check-success=golangci-lint-bot
-    - check-success=ansible
-    - check-success=Shellcheck
-    - check-success=markdown-lint
-    - check-success=DCO
-    # If files are changed in .github/, the actionlint check must pass
-    - or:
-      - and:
-        # regex should match the one in .github/workflows/actionlint.yml
-        - files~=.github/.*$
-        - check-success=actionlint
-      - -files~=.github/.*$
-  actions:
-    merge:
-      method: merge
+  - name: auto-merge
+    description: >
+      automatic merge for main with > 1 approved reviews,
+      all requested reviews have given feedback, not held, and CI is successful
+    conditions:
+      - "#approved-reviews-by>=1"
+      - "#review-requested=0"
+      - "#changes-requested-reviews-by=0"
+      - base=main
+      - label!=hold
+      - check-success=golangci-lint-worker
+      - check-success=golangci-lint-bot
+      - check-success=ansible
+      - check-success=Shellcheck
+      - check-success=markdown-lint
+      - check-success=DCO
+      # If files are changed in .github/, the actionlint check must pass
+      - or:
+        - and:
+          # regex should match the one in .github/workflows/actionlint.yml
+          - files~=.github/.*$
+          - check-success=actionlint
+        - -files~=.github/.*$
+    actions:
+      merge:
+        method: merge

.github/workflows/cherry-pick.yml

@@ -8,7 +8,8 @@ on:
 
 jobs:
   cherry_pick:
-    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'cherry-pick-release-1.0')
+    if: github.event.pull_request.merged == true &&
+        contains(github.event.pull_request.labels.*.name, 'cherry-pick-release-1.0')
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository

.github/workflows/lint-jobs.yml

@@ -14,6 +14,10 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
   shellcheck:
     name: Shellcheck
@@ -33,3 +37,30 @@ jobs:
         uses: DavidAnson/markdownlint-cli2-action@v19
         with:
           globs: "**/*.md"
+
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Harden Runner"
+        uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
+        with:
+          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
+
+      - name: "Checkout"
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          # https://github.com/actions/checkout/issues/249
+          fetch-depth: 0
+
+      # yamllint is a Python-based tool
+      - name: Setup Python 3.11
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: 3.11
+
+      - name: Setup yamllint
+        run: pip install yamllint>=1.35.1
+
+      # TODO: Expand YAML linting to beyond .github to validate other YAML files
+      - name: Run yamllint
+        run: yamllint -c yamllint.yaml .github

yamllint.yaml

@@ -0,0 +1,16 @@
+rules:
+  quoted-strings:
+    quote-type: any
+    required: false
+    allow-quoted-quotes: true
+    check-keys: true
+
+  line-length:
+    max: 120
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: false
+
+  indentation:
+    spaces: consistent
+    indent-sequences: whatever
+    check-multi-line-strings: false