[PR #250] [CLOSED] Add release drafter github workflow #2451

Closed
opened 2025-11-20 05:30:05 -05:00 by saavagebueno · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/250
Author: @havardthom
Created: 11/14/2024
Status: Closed

Base: mainHead: release-draft


📝 Commits (1)

  • 8578371 Add release drafter github workflow

📊 Changes

4 files changed (+187 additions, -12 deletions)

View changed files

📝 .github/autolabeler-config.json (+2 -9)
.github/release-draft-config.json (+37 -0)
📝 .github/workflows/autolabeler.yml (+0 -3)
.github/workflows/release-draft.yml (+148 -0)

📄 Description

Note

We are meticulous when it comes to merging code into the main branch, so please understand that we may reject pull requests that do not meet the project's standards. It's never personal. Also, game-related scripts have a lower chance of being merged.

Description

Adds a github workflow that creates a release draft on push to main branch. This will

  • Create release draft with notes categorized based on merged PRs labels
  • Adds semantic versioning and github tags
  • Allow users to see everything that has changed (since last release)
  • Allow users to get notified via github (if they want)
  • We don't have to manually update CHANGELOG.md

The draft release can be published when we want

For the release to be as correct as possible, PRs must be labelled accordingly. The autolabeler workflow will handle most PRs, but we should also manually check that PRs are labelled correctly before merging. It is also possible to fix labels on already merged PRs and rerun the release draft workflow manually before a release.

The config .github/release-draft-config.json specifies categories, corresponding labels and version increment for the github release tag.

Type of change

Please check the relevant option(s):

  • Bug fix (non-breaking change that resolves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (a fix or feature that would cause existing functionality to change unexpectedly)
  • New script (a fully functional and thoroughly tested script or set of scripts.)

Prerequisites

The following efforts must be made for the PR to be considered. Please check when completed:

  • Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions)
  • Testing performed (I have tested my changes, ensuring everything works as expected)
  • Documentation updated (I have updated any relevant documentation)

Additional Information (optional)

Provide any additional context or screenshots about the feature or fix here.

Screenshot 1:
draft-1

Screenshot 2:
draft-2

If there are other pull requests or discussions related to this change, please link them here:


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/250 **Author:** [@havardthom](https://github.com/havardthom) **Created:** 11/14/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `release-draft` --- ### 📝 Commits (1) - [`8578371`](https://github.com/community-scripts/ProxmoxVE/commit/85783711d8dc6464560d809276aa09c73a3d25f5) Add release drafter github workflow ### 📊 Changes **4 files changed** (+187 additions, -12 deletions) <details> <summary>View changed files</summary> 📝 `.github/autolabeler-config.json` (+2 -9) ➕ `.github/release-draft-config.json` (+37 -0) 📝 `.github/workflows/autolabeler.yml` (+0 -3) ➕ `.github/workflows/release-draft.yml` (+148 -0) </details> ### 📄 Description > [!NOTE] > We are meticulous when it comes to merging code into the main branch, so please understand that we may reject pull requests that do not meet the project's standards. It's never personal. Also, game-related scripts have a lower chance of being merged. ## Description Adds a github workflow that creates a release draft on push to `main` branch. This will - Create release draft with notes categorized based on merged PRs labels - Adds semantic versioning and github tags - Allow users to see everything that has changed (since last release) - Allow users to get notified via github (if they want) - We don't have to manually update `CHANGELOG.md` The draft release can be published when we want For the release to be as correct as possible, PRs must be labelled accordingly. The autolabeler workflow will handle most PRs, but we should also manually check that PRs are labelled correctly before merging. It is also possible to fix labels on already merged PRs and rerun the release draft workflow manually before a release. The config `.github/release-draft-config.json` specifies categories, corresponding labels and version increment for the github release tag. ## Type of change Please check the relevant option(s): - [ ] Bug fix (non-breaking change that resolves an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (a fix or feature that would cause existing functionality to change unexpectedly) - [ ] New script (a fully functional and thoroughly tested script or set of scripts.) ## Prerequisites The following efforts must be made for the PR to be considered. Please check when completed: - [x] Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions) - [x] Testing performed (I have tested my changes, ensuring everything works as expected) - [x] Documentation updated (I have updated any relevant documentation) ## Additional Information (optional) Provide any additional context or screenshots about the feature or fix here. Screenshot 1: ![draft-1](https://github.com/user-attachments/assets/d7165eb7-6a3e-4e99-a094-2d2d983a20e9) Screenshot 2: ![draft-2](https://github.com/user-attachments/assets/c13e8539-0214-4540-ac83-b348a9622039) ## Related Pull Requests / Discussions If there are other pull requests or discussions related to this change, please link them here: - Related https://github.com/community-scripts/ProxmoxVE/discussions/23 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2025-11-20 05:30:05 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE#2451