This is an automated email from the ASF dual-hosted git repository.
mridulpathak pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/trunk by this push:
new 121df729c0 Add an API changes section to the release notes
121df729c0 is described below
commit 121df729c030956faf4940a87baff355d23dfdcf
Author: Mridul Pathak <[email protected]>
AuthorDate: Tue Oct 27 20:11:04 2026 +0530
Add an API changes section to the release notes
Pull requests labelled api-change are listed under API changes, after the
security sections and before the type sections, so that upgraders find the
public API changes and removals instead of reading them as ordinary
improvements.
---
.github/README-CI-CD.md | 2 ++
.github/release.yml | 7 ++++++-
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/.github/README-CI-CD.md b/.github/README-CI-CD.md
index be130e6dc2..9a7f4316fc 100644
--- a/.github/README-CI-CD.md
+++ b/.github/README-CI-CD.md
@@ -49,6 +49,8 @@ New branches inherit workflow files from `trunk` at creation
time.
PRs labeled `cve` are listed under Security fixes and the other PRs labeled
`security` under Security hardening. These labels are set by hand: `cve` only
once the CVE is announced, then the release notes of the release can be
generated again, and `security` by the committer for security hardening without
a CVE.
+PRs that change or remove a public API (a public class, method or signature
that code outside OFBiz may use) are labeled `api-change` by hand by the
committer, and are listed under API changes so that upgraders find them. A PR
labeled `cve` or `security` stays in its security section.
+
GitHub reads `release.yml` from the tag being released, so it must be on the
release branch before the tag is created.
To label the PRs merged before `pr-type-label.yml` existed, run it manually
from the Actions tab with the date of the previous release, first as a dry run.
diff --git a/.github/release.yml b/.github/release.yml
index bcf841122d..b826a5c851 100644
--- a/.github/release.yml
+++ b/.github/release.yml
@@ -23,8 +23,10 @@
# The type labels are set from the PR title prefix by pr-type-label.yml.
# The cve and security labels are set by hand, cve only once the CVE is
# announced, after which the release notes can be generated again.
+# The api-change label is set by hand on a pull request that changes or removes
+# a public API, so that upgraders find it.
# A pull request is listed in the first category whose labels match, so the
-# security categories come before the type categories.
+# security and API categories come before the type categories.
# See
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
changelog:
@@ -40,6 +42,9 @@ changelog:
- title: Security hardening
labels:
- security
+ - title: API changes
+ labels:
+ - api-change
- title: Bug fixes
labels:
- bug
