AbsaOSS / AbsaOSS/release-notes-presence-check

Introduce guide when RLS notes missing

未關閉
#9 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement
主要語言
Python
星號
0
分支
0
平均合併
1 分鐘
30 天內合併 PR
4

描述

## Background

- Creating release notes (title and bullet list) requires manual effort or relies on PR templates. In both cases, the PR author needs to pay extra attention and follow a process that can be repetitive.
- To improve the developer experience and reduce time spent on boilerplate work, the action will offer two optional inputs to automate or assist with release notes creation.

## Feature

Introduce two new inputs:

### `guide`
- **Required**: No
- **Default**: `true`
- **Description**:
When enabled and no "Release Notes" section is found in the PR description, the action will post a helpful guide comment.
The comment includes:
- A short explanation + mention automated injection feature
- A release notes template
- A proposed draft generated from commit messages

This serves as a non-intrusive way to guide contributors.
If a guide comment from the action already exists, it won’t be posted again.

> 🔹 If both `guide` and `inject_proposed_draft` are enabled, the guide comment is **skipped** to avoid redundancy.

---

### `inject_proposed_draft`
- **Required**: No
- **Default**: `false`
- **Description**:
When enabled, the action will directly insert the generated release notes draft into the PR description.
This provides a ready-to-edit section based on commit messages, saving the author time.

> 🔸 This takes precedence over the `guide` input. When both are enabled, the guide comment will not be posted.

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。