starred/ProxmoxVE
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-02-05 08:40:11 +03:00
Code Issues 23 Packages Projects Releases 10 Wiki Activity

[PR #38] [CLOSED] Add Release Drafter workflow #2444

New Issue
Closed
opened 2026-02-05 04:56:10 +03:00 by OVERLORD · 0 comments
OVERLORD commented 2026-02-05 04:56:10 +03:00
Owner
Copy Link

📋 Pull Request Information

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

Base: main ← Head: main

📝 Commits (1)

  • f6cab74 Add Release Drafter workflow

📊 Changes

2 files changed (+96 additions, -0 deletions)

View changed files

➕ .github/release-drafter.yml (+55 -0)
➕ .github/workflows/release.yml (+41 -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

Putting this PR up for discussion based on https://github.com/community-scripts/ProxmoxVE/discussions/23

Adds Release Drafter workflow which creates draft releases based on PRs merged to main branch. We can choose when to publish a new release.

Benefits:

  • Removes the need for a fully manual changelog
  • Adds semantic versioning to our releases
  • More explicit when/what changes
  • Follows github release practices

Security aspects:

Prerequisites:

  • Add main branch protection so all commits to main requires PR (should have this regardless of this PR imo)
  • Add new labels breaking change, new script, update script, bug fix, chore for labelling PR's
  • An initial release (e.g. v1.0.0) should be published before using this

Also possible to use autolabeler which automatically labels PRs, but that means running the action on every PR. I disabled it because we have 2000 github action minutes per month. This should be enough for 2000 / 5min = 400 runs per month.

PRs

draft-release

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.)
  • Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions)
  • Documentation update required (this change requires an update to the documentation)

🔄 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/38 **Author:** [@havardthom](https://github.com/havardthom) **Created:** 11/3/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (1) - [`f6cab74`](https://github.com/community-scripts/ProxmoxVE/commit/f6cab74b68f9666f823108b50fc28f8905c05d0f) Add Release Drafter workflow ### 📊 Changes **2 files changed** (+96 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/release-drafter.yml` (+55 -0) ➕ `.github/workflows/release.yml` (+41 -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 Putting this PR up for discussion based on https://github.com/community-scripts/ProxmoxVE/discussions/23 Adds [Release Drafter workflow](https://github.com/release-drafter/release-drafter) which creates draft releases based on PRs merged to `main` branch. We can choose when to publish a new release. Benefits: - Removes the need for a fully manual changelog - Adds semantic versioning to our releases - More explicit when/what changes - Follows github release practices Security aspects: - Requires trust in [Release Drafter workflow](https://github.com/release-drafter/release-drafter), since [write permission](https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-contents) is required to create a github release Prerequisites: - Add main branch protection so all commits to `main` requires PR (should have this regardless of this PR imo) - Add new labels `breaking change`, `new script`, `update script`, `bug fix`, `chore` for labelling PR's - An initial release (e.g. v1.0.0) should be published before using this Also possible to use autolabeler which automatically labels PRs, but that means running the action on every PR. I disabled it because we have [2000 github action minutes](https://docs.github.com/en/get-started/learning-about-github/githubs-plans#github-free-for-organizations) per month. This should be enough for 2000 / 5min = 400 runs per month. ![PRs](https://github.com/user-attachments/assets/afd64860-e618-4247-99a7-a9573dcf2edb) ![draft-release](https://github.com/user-attachments/assets/06dae937-e291-4abc-8e00-1c9fa0fdeec0) ## 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.) - [x] Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions) - [ ] Documentation update required (this change requires an update to the documentation) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
OVERLORD added the pull-request label 2026-02-05 04:56:10 +03:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Implemented in VED waiting push to Main
breaking change
bug
bug
bugfix
deferred
delete script
dependencies
enhancement
external
feature
github
help wanted
in project pipeline
invalid
investigation
json
maintenance
needs triage
new script
new script
nice to have
not a script issue
not planned
organization
pull-request
Mirrored from GitHub Pull Request
 question
refactor
rename script
security
update script
website
wontdo
🛑 Failure to comply with the guidelines
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/ProxmoxVE#2444
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?