Skip to content

internal(changelog): Do not rewrite already released versions in rele… #76

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
Fral738 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

internal(changelog): Do not rewrite already released versions in rele… #76

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
35 changes: 34 additions & 1 deletion hack/chlog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ def main() -> int:
parser_release_notes.add_argument(
"--lang", "-l", type=str, required=True, help="Target language."
)
parser_release_notes.add_argument(
"--full",
action="store_true",
help="Regenerate all versions instead of only adding missing ones.",
)

parser_release_notes = subparsers.add_parser(
"translate",
Expand Down Expand Up @@ -121,6 +126,7 @@ def main() -> int:
parsed_args.directory,
parsed_args.lang,
parsed_args.output,
parsed_args.full,
)

if parsed_args.subcommand == "translate":
Expand Down Expand Up @@ -241,11 +247,19 @@ def changelog_handler(


@ensure_yq
def release_notes_handler(changelog_dir: str, lang: str, output: str = "") -> int:
def release_notes_handler(
changelog_dir: str, lang: str, output: str = "", full: bool = False
) -> int:
if lang not in ["en", "ru"]:
logging.error('language must be either "en" or "ru".')
return 1

# existing sections are kept verbatim unless --full is set,
# so already released versions are never rewritten
existing_sections = {}
if not full and output and os.path.exists(output):
existing_sections = parse_release_notes_sections(output)

changelog_files = sorted(
glob.glob(pathname=os.path.join(changelog_dir, "*.yaml")), key=lambda f: [int(n) for n in re.findall(r'\d+', f)], reverse=True
)
Expand Down Expand Up @@ -301,6 +315,11 @@ def release_notes_handler(changelog_dir: str, lang: str, output: str = "") -> in
"chore": "",
}

if entries["version"] in existing_sections:
logging.debug("keeping existing section: %s", entries["version"])
markdown += existing_sections[entries["version"]]
continue

for category, changes in changelog.items():
logging.debug("processing category: %s", category)
if changes:
Expand All @@ -325,6 +344,20 @@ def release_notes_handler(changelog_dir: str, lang: str, output: str = "") -> in
return 0


def parse_release_notes_sections(filename: str) -> dict:
"""Split an existing release notes file into per-version markdown sections."""
with open(filename, "r", encoding="utf-8") as f:
content = f.read()

sections = {}
for match in re.finditer(
r"\n## (v\S+)\n.*?(?=\n## v|\Z)", content, flags=re.S
):
sections[match.group(1)] = match.group(0).rstrip() + "\n"

return sections


# Leading verbs converted to past tense when rendering release notes.
# Changelog yaml files keep the original (imperative) wording.
PAST_TENSE = {
Expand Down
Loading