Skip to content

Commit 07c498b

Browse files
committed
feat(github): improve PR labeling and changelog generation
Autolabeler improvements: - Always parse template checkboxes (removed size < 2 restriction) - Better handling of update script + json + content label combinations - Fixed documentation checkbox mapping to 'maintenance' label Changelog config improvements: - Added '🗑️ Deleted Scripts' category for delete script label - Added '💾 Core' as main category (was subcategory under Maintenance) - Renamed 'Unlabelled' to 'Uncategorized' with 'needs triage' label - Removed Documentation subcategory (redundant with maintenance) Changelog workflow improvements: - Added fallback to 'Uncategorized' for PRs without matching labels This ensures: - PRs with ct/install + json changes + bugfix = 'update script' + 'bugfix' - Core changes (misc/*.func) get their own changelog section - Deleted scripts are tracked in changelog - No PRs fall through without categorization
1 parent c72823f commit 07c498b

File tree

5 files changed

+97
-50
lines changed

5 files changed

+97
-50
lines changed

.github/changelog-pr-config.json

Lines changed: 42 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/autolabeler.yml

Lines changed: 34 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/changelog-pr.yml

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030

3131
<br />
3232

33-
> **Simplify your Proxmox VE setup with community-driven automation scripts**
34-
> Originally created by tteck, now maintained and expanded by the community
33+
> **Simplify your Proxmox VE setup with community-driven automation scripts**
34+
> Originally created by tteck, now maintained and expanded by the community
3535
3636
</div>
3737

docs/contribution/CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
21
# Community Scripts Contribution Guide
32

4-
## **Welcome to the communty-scripts Repository!**
3+
## **Welcome to the communty-scripts Repository!**
54

65
📜 These documents outline the essential coding standards for all our scripts and JSON files. Adhering to these standards ensures that our codebase remains consistent, readable, and maintainable. By following these guidelines, we can improve collaboration, reduce errors, and enhance the overall quality of our project.
76

@@ -28,7 +27,6 @@ By following the coding standards outlined in this document, we ensure that our
2827

2928
Let's work together to keep our codebase clean, efficient, and maintainable! 💪🚀
3029

31-
3230
## Getting Started
3331

3432
Before contributing, please ensure that you have the following setup:
@@ -40,6 +38,7 @@ Before contributing, please ensure that you have the following setup:
4038
- [Shell Format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format)
4139

4240
### Important Notes
41+
4342
- Use [AppName.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/templates_ct/AppName.sh) and [AppName-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/templates_install/AppName-install.sh) as templates when creating new scripts.
4443

4544
---
@@ -67,32 +66,39 @@ Start with the [template script](https://github.com/community-scripts/ProxmoxVE/
6766
## 🤝 Contribution Process
6867

6968
### 1. Fork the repository
69+
7070
Fork to your GitHub account
7171

72-
### 2. Clone your fork on your local environment
72+
### 2. Clone your fork on your local environment
73+
7374
```bash
7475
git clone https://github.com/yourUserName/ForkName
7576
```
7677

7778
### 3. Create a new branch
79+
7880
```bash
7981
git switch -c your-feature-branch
8082
```
8183

8284
### 4. Change paths in build.func install.func and AppName.sh
85+
8386
To be able to develop from your own branch you need to change `https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main` to `https://raw.githubusercontent.com/[USER]/[REPOSITORY]/refs/heads/[BRANCH]`. You need to make this change atleast in misc/build.func misc/install.func and in your ct/AppName.sh. This change is only for testing. Before opening a Pull Request you should change this line change all this back to point to `https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main`.
8487

8588
### 4. Commit changes (without build.func and install.func!)
89+
8690
```bash
8791
git commit -m "Your commit message"
8892
```
8993

9094
### 5. Push to your fork
95+
9196
```bash
9297
git push origin your-feature-branch
9398
```
9499

95100
### 6. Create a Pull Request
101+
96102
Open a Pull Request from your feature branch to the main repository branch. You must only include your **$AppName.sh**, **$AppName-install.sh** and **$AppName.json** files in the pull request.
97103

98104
---
@@ -102,5 +108,3 @@ Open a Pull Request from your feature branch to the main repository branch. You
102108
- [CT Template: AppName.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/templates_ct/AppName.sh)
103109
- [Install Template: AppName-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/templates_install/AppName-install.sh)
104110
- [JSON Template: AppName.json](https://github.com/community-scripts/ProxmoxVE/blob/main/docs/contribution/templates_json/AppName.json)
105-
106-

0 commit comments

Comments
 (0)