adding required files for new ruleset

xoap-io · Feb 27, 2024 · 468241b · 468241b
1 parent e403844
commit 468241b
Show file tree

Hide file tree

Showing 4 changed files with 103 additions and 52 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,52 +1,33 @@
-<!--
-    Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project
-    is greatly appreciated!
-
-    Please prefix the PR title with the resource name, e.g. 'ResourceName: My short description'.
-    If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:',
-    e.g. 'BREAKING CHANGE: ResourceName: My short description'.
-
-    You may remove this comment block, and the other comment blocks, but please keep the headers
-    and the task list.
--->
-
-#### Pull Request (PR) description
-
-<!--
-    Replace this comment block with a description of your PR. Also, make sure you have updated the
-    CHANGELOG.md, see the task list below. An entry in the CHANGELOG.md is mandatory for all PRs.
--->
-
-#### This Pull Request (PR) fixes the following issues
-
-<!--
-    If this PR does not fix an open issue, replace this comment block with None. If this PR
-    resolves one or more open issues, replace this comment block with a list of the issues using
-    a GitHub closing keyword, e.g.:
-
-- Fixes #123
-- Fixes #124
--->
-
-#### Task list
-
-<!--
-    To aid community reviewers in reviewing and merging your PR, please take the time to run
-    through the below checklist and make sure your PR has everything updated as required.
-
-    Change to [x] for each task in the task list that applies to your PR. For those task that
-    don't apply to you PR, leave those as is.
--->
-
-- [ ] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
-      Entry should say what was changed and how that affects users (if applicable), and
-      reference the issue being resolved (if applicable).
-- [ ] Resource documentation added/updated in README.md.
-- [ ] Resource parameter descriptions added/updated in README.md, schema.mof and comment-based
-      help.
-- [ ] Comment-based help added/updated.
-- [ ] Localization strings added/updated in all localization files as appropriate.
-- [ ] Examples appropriately added/updated.
-- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
-- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
-- [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).
+# Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests or screenshots that prove my fix is effective or that my feature works
+- [ ] Any dependent changes have been merged and published in downstream modules
+
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -0,0 +1,19 @@
+Feature:
+ - head-branch: ['^feature', 'feature']
+Hotfix:
+ - head-branch: ['^hotfix', 'hotfix']
+Documentation:
+- changed-files:
+  - any-glob-to-any-file: '**/*.md'
+CICD:
+- changed-files:
+  - any-glob-to-any-file: '.github/**'
+
+typescript:
+- changed-files:
+  - any-glob-to-any-file:  '**/*.ts'
+css:
+- changed-files:
+  - any-glob-to-any-file:  '**/*.css'
+
+
diff --git a/.github/reviewers.yml b/.github/reviewers.yml
@@ -0,0 +1,4 @@
+reviewers:
+  defaults:
+    - repository-owners
+    - bbrauneck
diff --git a/.github/workflows/labelling.yaml b/.github/workflows/labelling.yaml
@@ -0,0 +1,47 @@
+name: label PRs
+on:
+  pull_request:
+    branches: [dev, master]
+jobs:
+  size-label:
+    needs: pr-reviewer 
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: size-label
+        uses: "pascalgn/size-label-action@v0.5.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+        with:
+          sizes: >
+            {
+              "0": "XS",
+              "20": "S",
+              "50": "M",
+              "200": "L",
+              "800": "XL",
+              "2000": "XXL"
+            }
+      - name: general-labels
+        uses: actions/labeler@v5
+        with:
+          sync-labels: true
+  pr-reviewer:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+      - name: Request review and assign
+        uses: necojackarc/auto-request-review@v0.13.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config: .github/reviewers.yml 
+          use_local: true