From e6dd7ac5a10ebe36686fa5a8c7c9a3131d7847c2 Mon Sep 17 00:00:00 2001 From: Michel Roegl-Brunner <73236783+michelroegl-brunner@users.noreply.github.com> Date: Tue, 18 Mar 2025 11:54:58 +0100 Subject: [PATCH] Update pr template and WF (#3200) * update pr template and WF * update pr template and WF * update pr template and WF --- .github/autolabeler-config.json | 28 ++++++++++++++----- .github/changelog-pr-config.json | 15 ++++++++++ .github/pull_request_template.md | 45 ++++++++++++++++++++---------- .github/workflows/autolabeler.yml | 1 + .github/workflows/changelog-pr.yml | 5 +++- 5 files changed, 72 insertions(+), 22 deletions(-) diff --git a/.github/autolabeler-config.json b/.github/autolabeler-config.json index 50e73e910..068d559fb 100644 --- a/.github/autolabeler-config.json +++ b/.github/autolabeler-config.json @@ -1,4 +1,3 @@ - { "new script": [ { @@ -16,7 +15,7 @@ ], "delete script": [ { - "fileStatus": "removed", + "fileStatus": "removed", "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"], "excludeGlobs": [] } @@ -24,7 +23,13 @@ "maintenance": [ { "fileStatus": null, - "includeGlobs": ["*.md", ".github/**", "misc/*.func", "ct/create_lxc.sh", "api/**"], + "includeGlobs": [ + "*.md", + ".github/**", + "misc/*.func", + "ct/create_lxc.sh", + "api/**" + ], "excludeGlobs": [] } ], @@ -67,10 +72,19 @@ "high risk": [ { "fileStatus": null, - "includeGlobs": ["misc/build.func", "misc/install.func", "ct/create_lxc.sh"], + "includeGlobs": [ + "misc/build.func", + "misc/install.func", + "ct/create_lxc.sh" + ], + "excludeGlobs": [] + } + ], + "documentation": [ + { + "fileStatus": null, + "includeGlobs": ["*.md"], "excludeGlobs": [] } ] - - -} \ No newline at end of file +} diff --git a/.github/changelog-pr-config.json b/.github/changelog-pr-config.json index 2c62aa3f0..2f4eae06e 100644 --- a/.github/changelog-pr-config.json +++ b/.github/changelog-pr-config.json @@ -21,6 +21,11 @@ "title": "💥 Breaking Changes", "labels": ["breaking change"], "notes" : [] + }, + { + "title": "🔧 Refactor", + "labels": ["refactor"], + "notes" : [] } ] }, @@ -57,6 +62,16 @@ "title": "📂 Github", "labels": ["github"], "notes" : [] + }, + { + "title" :"📝 Documentation", + "labels": ["documentation"], + "notes" : [] + }, + { + "title" :"🔧 Refactor", + "labels": ["refactor"], + "notes" : [] } ] }, diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d669ec78a..0f3ff54ac 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,42 @@ -## ✍️ Description - +🛑 **New scripts must first be submitted to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) for testing.** +PRs for new scripts that skip this process will be closed. -## 🔗 Related PR / Discussion / Issue +--- + +## ✍️ Description + + +## 🔗 Related PR / Issue Link: # -## ✅ Prerequisites +## ✅ Prerequisites (**X** in brackets) -Before this PR can be reviewed, the following must be completed: +- [ ] **Self-review completed** – Code follows project standards. +- [ ] **Tested thoroughly** – Changes work as expected. +- [ ] **No breaking changes** – Existing functionality remains intact. +- [ ] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues. -- [] **Self-review performed** – Code follows established patterns and conventions. -- [] **Testing performed** – Changes have been thoroughly tested and verified. +--- -## 🛠️ Type of Change +## 🛠️ Type of Change (**X** in brackets) -Select all that apply: +- [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality. +- [ ] ✨ **New feature** – Adds new, non-breaking functionality. +- [ ] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. +- [ ] 🆕 **New script** – A fully functional and tested script or script set. +- [ ] 🌍 **Website update** – Changes to website-related JSON files or metadata. +- [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality. +- [ ] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs. + +--- + +## 🔍 Code & Security Review (**X** in brackets) + +- [ ] **Follows `Code_Audit.md` & `CONTRIBUTING.md` guidelines** +- [ ] **Uses correct script structure (`AppName.sh`, `AppName-install.sh`, `AppName.json`)** +- [ ] **No hardcoded credentials** -- [] 🆕 **New script** – A fully functional and tested script or script set. -- [] 🐞 **Bug fix** – Resolves an issue without breaking functionality. -- [] ✨ **New feature** – Adds new, non-breaking functionality. -- [] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. ## 📋 Additional Information (optional) - + diff --git a/.github/workflows/autolabeler.yml b/.github/workflows/autolabeler.yml index 75eba1c19..d72f66094 100644 --- a/.github/workflows/autolabeler.yml +++ b/.github/workflows/autolabeler.yml @@ -67,6 +67,7 @@ jobs: "🐞 **Bug fix**": "bugfix", "✨ **New feature**": "feature", "💥 **Breaking change**": "breaking change", + "🔧 **Refactoring / Code Cleanup**": "refactor", }; for (const [checkbox, label] of Object.entries(templateLabelMappings)) { diff --git a/.github/workflows/changelog-pr.yml b/.github/workflows/changelog-pr.yml index 036ef7a7c..fa499b5d8 100644 --- a/.github/workflows/changelog-pr.yml +++ b/.github/workflows/changelog-pr.yml @@ -63,13 +63,16 @@ jobs: { title: "🐞 Bug Fixes", labels: ["bugfix"], notes: [] }, { title: "✨ New Features", labels: ["feature"], notes: [] }, { title: "💥 Breaking Changes", labels: ["breaking change"], notes: [] } + { title: "🔧 Refactor, labels: ["refactor"], notes: [] } ] : obj.labels.includes("maintenance") ? [ { title: "🐞 Bug Fixes", labels: ["bugfix"], notes: [] }, { title: "✨ New Features", labels: ["feature"], notes: [] }, { title: "💥 Breaking Changes", labels: ["breaking change"], notes: [] }, { title: "📡 API", labels: ["api"], notes: [] }, - { title: "Github", labels: ["github"], notes: [] } + { title: "Github", labels: ["github"], notes: [] }, + { title: "📝 Documentation", labels: ["documentation"], notes: [] } + { title: "🔧 Refactor, labels: ["refactor"], notes: [] } ] : obj.labels.includes("website") ? [ { title: "🐞 Bug Fixes", labels: ["bugfix"], notes: [] },