Skip to content

ci: generate release changelogs in PRs without committing CHANGELOG.md #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
passcod wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ci: generate release changelogs in PRs without committing CHANGELOG.md #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/target
*.txt
/testfiles

# release-plz generates these to populate the release PR body; we don't commit
# them (matches CHANGELOG.md in the repo root and every crate directory).
CHANGELOG.md
6 changes: 5 additions & 1 deletion release-plz.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
pr_name = "repo: release"
pr_branch_prefix = "release-plz/"
pr_labels = ["autorelease"]
changelog_update = false
# Generate changelogs so the release PR body lists the changes, but keep them
# out of the repo: CHANGELOG.md is gitignored, so release-plz writes it to
# populate the PR body without committing it. GitHub release notes are derived
# from the committed file, so they stay empty by design.
changelog_update = true
git_tag_name = "{{ package }}-v{{ version }}"

[[package]]
Expand Down
Loading