Skip to content

RDoc-3626 Added default what's new page content #2209

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

Merged
ppekrol merged 1 commit into from
Dec 29, 2025
Merged

RDoc-3626 Added default what's new page content #2209

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
15 changes: 14 additions & 1 deletion scripts/build_whats_new.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@
"---\n\n"
)

DEFAULT_WHATS_NEW_CONTENT = """
This version is under development and hasn't been released yet.
"""

# Date format used by the API – helper for ``datetime.strptime``
API_DATE_FMT = "%m/%d/%Y"

Expand Down Expand Up @@ -225,6 +229,11 @@ def write_whats_new_file(destination: Path, entries: List[Dict[str, Any]]) -> No
body = "".join(mdx_block(e) for e in entries)
destination.write_text(FRONT_MATTER + body, encoding="utf-8")

def write_default_whats_new_file(destination: Path)-> None:
destination.parent.mkdir(parents=True, exist_ok=True)

destination.write_text(FRONT_MATTER + DEFAULT_WHATS_NEW_CONTENT, encoding="utf-8")

# ============================================================================
# Command-line interface
# ============================================================================
Expand All @@ -249,7 +258,11 @@ def main() -> None:
is_primary = branch == primary_branch
changelog_entries = fetch_branch_entries(branch)
target_file = output_path_for(branch, is_primary)
write_whats_new_file(target_file, changelog_entries)

if len(changelog_entries) == 0 or changelog_entries[0].get("version").startswith(branch) == False:
write_default_whats_new_file(target_file)
else:
write_whats_new_file(target_file, changelog_entries)

print(f"Wrote {target_file.relative_to(PROJECT_ROOT)}")

Expand Down