[PR #299] [MERGED] Add github workflow for automatic changelog PR #2543

Closed
opened 2026-02-05 05:01:09 +03:00 by OVERLORD · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/299
Author: @havardthom
Created: 11/17/2024
Status: Merged
Merged: 11/17/2024
Merged by: @havardthom

Base: mainHead: auto-changelog


📝 Commits (1)

  • df2804e Add automatic changelog PR github workflow

📊 Changes

3 files changed (+169 additions, -0 deletions)

View changed files

.github/changelog-pr-config.json (+30 -0)
.github/workflows/changelog-pr.yml (+136 -0)
📝 CHANGELOG.md (+3 -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

This PR adds a github workflow which creates and updates a pull request with automatic updates to CHANGELOG.md. The changelog notes are generated based on pull requests merged to main branch since the previous changelog update date. The changelog notes are categorized based on pull request labels.

The CHANGELOG.md pull request will be created/updated on every push to main branch, and we can choose when we want to merge it. It handles both updating existing changelog notes for todays date, or adding new notes if todays date has not yet been added.

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.

changelog-1
changelog-2
changelog-3
changelog-4
changelog-5

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

  • Related PR #

🔄 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/299 **Author:** [@havardthom](https://github.com/havardthom) **Created:** 11/17/2024 **Status:** ✅ Merged **Merged:** 11/17/2024 **Merged by:** [@havardthom](https://github.com/havardthom) **Base:** `main` ← **Head:** `auto-changelog` --- ### 📝 Commits (1) - [`df2804e`](https://github.com/community-scripts/ProxmoxVE/commit/df2804e3b1755628c9cfc0774f3a3dd66a385d86) Add automatic changelog PR github workflow ### 📊 Changes **3 files changed** (+169 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/changelog-pr-config.json` (+30 -0) ➕ `.github/workflows/changelog-pr.yml` (+136 -0) 📝 `CHANGELOG.md` (+3 -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 This PR adds a github workflow which creates and updates a pull request with automatic updates to CHANGELOG.md. The changelog notes are generated based on pull requests merged to `main` branch since the previous changelog update date. The changelog notes are categorized based on pull request labels. The CHANGELOG.md pull request will be created/updated on every push to `main` branch, and we can choose when we want to merge it. It handles both updating existing changelog notes for todays date, or adding new notes if todays date has not yet been added. ## 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. ![changelog-1](https://github.com/user-attachments/assets/5173af6e-94fc-434a-aa7d-ed960879d10c) ![changelog-2](https://github.com/user-attachments/assets/37771b35-e9a6-4a18-923c-dd520923a4f7) ![changelog-3](https://github.com/user-attachments/assets/4659f4ff-527d-4f19-8d19-5c67bfaf0424) ![changelog-4](https://github.com/user-attachments/assets/b53649cd-bc57-4919-a80a-735ff2f6f760) ![changelog-5](https://github.com/user-attachments/assets/7f181ca9-89ca-4911-8f96-330338704277) ## Related Pull Requests / Discussions If there are other pull requests or discussions related to this change, please link them here: - Related PR # --- <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 05:01:09 +03:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/ProxmoxVE#2543