mirror of
https://github.com/Sea-Haven-Industries/open-swe.git
synced 2026-10-03 16:43:26 +00:00
feat: add release note section to PR body template (#1202)
* feat: add release note section to PR body template The langchainplus repo PR template includes a ## Release Note section, but the agent hardcoded PR body template only had ## Description and ## Test Plan. This caused the release note section to be dropped from agent-created PRs. * docs: align PR body argument docs --------- Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com> Co-authored-by: Johannes du Plessis <johannes@langchain.dev>
This commit is contained in:
parent
4af9eb885c
commit
b829cef97a
2 changed files with 13 additions and 1 deletions
|
|
@ -294,6 +294,9 @@ When you have completed your implementation, follow these steps in order:
|
||||||
<1-3 sentences on WHY and the approach.
|
<1-3 sentences on WHY and the approach.
|
||||||
NO "Changes:" section — file changes are already in the commit history.>
|
NO "Changes:" section — file changes are already in the commit history.>
|
||||||
|
|
||||||
|
## Release Note
|
||||||
|
<One-line changelog summary for self-hosted customers, or "none" for internal/CI/test/refactor changes.>
|
||||||
|
|
||||||
## Test Plan
|
## Test Plan
|
||||||
- [ ] <new/novel verification steps only — NOT "run existing tests" or "verify existing behavior">
|
- [ ] <new/novel verification steps only — NOT "run existing tests" or "verify existing behavior">
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -89,6 +89,11 @@ def commit_and_open_pr(
|
||||||
DO NOT list files changed or enumerate code
|
DO NOT list files changed or enumerate code
|
||||||
changes — that information is already in the commit history.>
|
changes — that information is already in the commit history.>
|
||||||
|
|
||||||
|
## Release Note
|
||||||
|
<One-line summary for the changelog, written for self-hosted customers.
|
||||||
|
Write "none" for changes that don't need a changelog entry
|
||||||
|
(internal, CI, tests, refactors, etc.)>
|
||||||
|
|
||||||
## Test Plan
|
## Test Plan
|
||||||
- [ ] <new test case or manual verification step ONLY for new behavior>
|
- [ ] <new test case or manual verification step ONLY for new behavior>
|
||||||
|
|
||||||
|
|
@ -107,6 +112,9 @@ def commit_and_open_pr(
|
||||||
|
|
||||||
Resolves AA-123
|
Resolves AA-123
|
||||||
|
|
||||||
|
## Release Note
|
||||||
|
Fixed authentication failure for users without profiles.
|
||||||
|
|
||||||
## Test Plan
|
## Test Plan
|
||||||
- [ ] Verify login works for users without profiles
|
- [ ] Verify login works for users without profiles
|
||||||
|
|
||||||
|
|
@ -118,7 +126,8 @@ def commit_and_open_pr(
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
title: PR title following the format above (e.g. "fix: resolve auth bug [closes AA-123]")
|
title: PR title following the format above (e.g. "fix: resolve auth bug [closes AA-123]")
|
||||||
body: PR description following the template above with ## Description and ## Test Plan
|
body: PR description following the template above with ## Description,
|
||||||
|
## Release Note, and ## Test Plan
|
||||||
commit_message: Optional git commit message. If not provided, the PR title is used.
|
commit_message: Optional git commit message. If not provided, the PR title is used.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue