Skip to content

Commit baedbf1

Browse files
committed
Add changelog to commit and PR message
1 parent 4df8456 commit baedbf1

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

src/main.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ class CommittedChanges(t.NamedTuple):
175175
base_branch: t.Optional[str]
176176

177177

178-
def commit_message(changes: t.List[str]) -> str:
178+
def commit_subject(changes: t.List[str]) -> str:
179179
assert len(changes) >= 1
180180

181181
if len(changes) == 1:
@@ -206,13 +206,22 @@ def commit_message(changes: t.List[str]) -> str:
206206

207207
def commit_changes(changes: t.List[str]) -> CommittedChanges:
208208
log.info("Committing updates")
209+
log.debug("For changes %s", repr(changes))
210+
subject = commit_subject(changes)
209211
body: t.Optional[str]
210-
subject = commit_message(changes)
212+
# message will be the git-style combination of subject and message
213+
# we'll still need the parts for PR creation later
214+
211215
if len(changes) > 1:
212216
body = "\n".join(changes)
213-
message = subject + "\n\n" + body
214217
else:
215218
body = None
219+
# move the changelog url from subject to body
220+
if "\n" in subject:
221+
subject, body = subject.split("\n", maxsplit=1)
222+
if body:
223+
message = subject + "\n\n" + body
224+
else:
216225
message = subject
217226

218227
# Remember the base branch
@@ -275,6 +284,7 @@ def commit_changes(changes: t.List[str]) -> CommittedChanges:
275284
except subprocess.CalledProcessError:
276285
# If not, create it
277286
check_call(["git", "checkout", "-b", branch])
287+
log.debug("Commited with subject='%s', message='%s', body='%s'", subject, repr(message), repr(body))
278288
return CommittedChanges(
279289
subject=subject,
280290
body=body,

src/manifest.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -450,13 +450,15 @@ def _update_manifest(self, path, datas, changes):
450450
if data.new_version is None:
451451
continue
452452

453+
changelog = "\nChangelog: " + data.new_version.changelog_url if data.new_version.changelog_url else ""
454+
453455
data.update()
454456
if data.new_version.version is not None:
455-
message = "{}: Update {} to {}".format(
456-
data.module, data.filename, data.new_version.version
457+
message = "{}: Update {} to {}{}".format(
458+
data.module, data.filename, data.new_version.version, changelog
457459
)
458460
else:
459-
message = "{}: Update {}".format(data.module, data.filename)
461+
message = "{}: Update {}{}".format(data.module, data.filename, changelog)
460462

461463
changes[message] = None
462464
path_has_changes = True

0 commit comments

Comments
 (0)