PR#234: fix: replace % with %% in changelogs to escape macros - fedora-infra/rpmautospec

fedora-infra / rpmautospec

#234 fix: replace % with %% in changelogs to escape macros

Closed 2 years ago by nphilipp. Opened 2 years ago by ankursinha.

fedora-infra/ ankursinha/rpmautospec fix/double-percent-for-macros into main

fix: simply replace all % with %%

Ankur Sinha (Ankur Sinha Gmail) • 2 years ago

c7acb97

chore: format with black

Ankur Sinha (Ankur Sinha Gmail) • 2 years ago

918b307

fix: replace % with %% in changelogs to escape macros

Ankur Sinha (Ankur Sinha Gmail) • 2 years ago

bacc108

rpmautospec/pkg_history.py

file modified

+1 -1

		`@@ -363,7 +363,7 @@`
		`)`

		`if not skip_for_changelog:`
		`- commit_subject = commit.message.split("\n", 1)[0].strip()`
		`+ commit_subject = commit.message.split("\n", 1)[0].strip().replace("%", "%%")`
		`if commit_subject.startswith("-"):`
		`commit_subject = commit_subject[1:].lstrip()`
		`if not commit_subject:`

ankursinha commented 2 years ago

first replace all occurrences of mutliple % with one %
replace all single % with %%

(There must be a more straight forward way to do it with a single
substitution using regex, but this was simple enough also).

Fixes #224

zuul commented 2 years ago

Build failed. More information on how to proceed and troubleshoot errors available at https://fedoraproject.org/wiki/Zuul-based-ci

pre-commit : FAILURE in 2m 31s
pytest-rawhide : SUCCESS in 4m 15s
pytest-f34 : SUCCESS in 2m 58s
pytest-f33 : SUCCESS in 2m 43s
rpm-mock-build : SUCCESS in 5m 56s

1 new commit added

chore: format with black

2 years ago

zuul commented 2 years ago

Build succeeded.

pre-commit : SUCCESS in 1m 52s
pytest-rawhide : SUCCESS in 3m 10s
pytest-f34 : SUCCESS in 2m 18s
pytest-f33 : SUCCESS in 2m 23s
rpm-mock-build : SUCCESS in 5m 59s

zbyszek commented 2 years ago

So this is actually wrong. There is no reason to replace multiple percent symbols by a single one. All is needed is .replace('%', '%%').

For example:
commit message 1: "We need to always remember use doubled %% instead of single % in the spec"
commit message 2: "We need to also remember to use %%%% when we want a double %% in the spec"
should be rendered as
changelog entry 1: "- We need to always remember use doubled %%%% instead of single %% in the spec"
changelog entry 2: "We need to also remember to use %%%%%%%% when we want a double %%%% in the spec"

In other words, % has no special meaning in git commit messages and each of those needs to be replaced by %% so that it looks the same as the original string when rendered by rpm.

1 new commit added

fix: simply replace all % with %%

2 years ago

ankursinha commented 2 years ago

that's even simpler then, updated.

zbyszek commented 2 years ago

LGTM!

zuul commented 2 years ago

Build failed. More information on how to proceed and troubleshoot errors available at https://fedoraproject.org/wiki/Zuul-based-ci

pre-commit : SUCCESS in 1m 41s
pytest-rawhide : FAILURE in 2m 57s
pytest-f34 : FAILURE in 2m 06s
pytest-f33 : FAILURE in 2m 07s
rpm-mock-build : FAILURE in 6m 29s

ankursinha commented 2 years ago

Could someone from the dev team please take a look to see if anything in the PR is causing the test failures, and if not, merge this? Cheers

nphilipp commented 2 years ago

Sorry, I fixed this differently in the 'long changelog entries' part of #244, which required refactoring how the changelog is generated substantially so this wouldn't apply.