added automatic release svg generation #2327

bhargav-j47 · 2025-11-08T14:38:16Z

this PR adds feature #2297, fixes #2297

PR introduces following changes:
Automates the generation of the release roadmap SVG using a Python script and json.
changes download page from release-roadmap.png to release-roadmap.svg

for more information, see https://pre-commit.ci

fixed colors

for more information, see https://pre-commit.ci

sarahboyce

Thank you for the PR! This is really strong

I have added some suggestions to make it easier to generate future svgs and how to make the generated image a little closer to the existing image

I think once we're happy with the generated image, we might want to consider writing a few tests

Makefile

djangoproject/templates/releases/download.html

tools/generate_release_roadmap.py

tools/release-data.json

tools/template.svg.jinja

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>

for more information, see https://pre-commit.ci

bhargav-j47 · 2025-11-18T20:49:50Z

Hi , thank you for the review . I have added suggested changes , please do let me know if anything needs to be added

sarahboyce

I have suggested changes which would end up generating the following image

After commiting suggestions you will need to update the current image committed by re-running the command.
A nice to have would be if we can end the graph one line earlier and add a fade out 🤔
We still have some minor discrepancies but I think it's "close enough"

djangoproject/templates/releases/download.html

tools/generate_release_roadmap.py

tools/template.svg.jinja

tools/generate_release_roadmap.py

for more information, see https://pre-commit.ci

bhargav-j47 · 2025-11-19T14:18:52Z

commited the suggested changes
-added fade at last of graph
-graph now ends one line earlier
-done changes to match the style of svg with old png

with changes release-roadmap.svg looks like this

sarahboyce

Thank you for the updates @bhargav-j47 !

If we can have the "April", "August", "December" labels on being on the lines as in the original image, I think that would be amazing ✨

I think this is ready for a review from the website WG 👍

sarahboyce

Just realized the LTS extended support is all about 8 months too short, can you update (also update the svg)?

tools/generate_release_roadmap.py

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>

djangoproject/templates/releases/download.html

bmispelon · 2025-11-19T19:28:06Z

tools/generate_release_roadmap.py

+OUTPUT_FILE = os.path.join(
+    BASE_DIR, "..", "djangoproject", "static", "img", "release-roadmap.svg"
+)


Minor: Can we use pathlib.Path for all path manipulations in this file? This would let us use OUTPUT_file.write_text(...) later on.

bmispelon · 2025-11-19T19:30:50Z

tools/generate_release_roadmap.py

+def add_months(date: dtime.date, months: int) -> dtime.date:
+    year = date.year + (date.month - 1 + months) // 12
+    month = (date.month - 1 + months) % 12 + 1
+    day = min(date.day, calendar.monthrange(year, month)[1])
+    return dtime.date(year, month, day)


Minor: It seems that we already pull python-dateutil as a dependency somehow (looking at pip freeze | grep dateutil), so we could add it to our requirements file explicitly and use it here:

from dateutil.relativedelta import relativedelta release_date + relativedelta(months=8)

bmispelon · 2025-11-19T19:36:55Z

tools/generate_release_roadmap.py

+        "--first-release", required=True, help="First release number, e.g., 4.2"
+    )
+    parser.add_argument(
+        "--date", required=True, help="Release date in YYYY-MM format, e.g., 2023-04"


Suggestion: You could use argparse's type parameter to have this automatically be converted to a date object: https://docs.python.org/3/library/argparse.html#type

bmispelon

I clicked the wrong button and left individual comments rather than a review 🤦🏻

I left a few suggestions, some stronger than others (the content type issue for the og_image should really be fixed, the others are optional).

I also noticed two visual differences with the previous png image, not sure if it's been discussed already but I thought I'd point them out:

The legend texts ("Mainstream support" and "Extended support") are not centered anymore, they seem to be left-aligned
The month names are now horizontal instead of vertical as they were before, was that intentional?

Finally, in terms of code layout I'm a bit wary about adding a new tools directory. Could we make this a management command inside the existing releases app?

Thanks again for your work! 🎸

for more information, see https://pre-commit.ci

bhargav-j47 · 2025-11-20T17:40:53Z

i have commit suggested changes

created og_image_type that defaults to img/png but can override to use svg
using pathlib.Path for paths
using relativedelta instead of custom add months function
centered legend text
month lables now look exactly like original png

i have also added svg generation as management command in releases app with usage "python -m manage generate_release_roadmap --first release --date
if these changes are approved , tools directory can be removed completely

sarahboyce · 2025-11-21T19:07:31Z

Tested the management command - looks good to me! Please remove the tools directory 👍

bmispelon

I've tested the management command and it works well. As Sarah pointed out, you can remove the tools directory now.

I've also left a small suggestion to simplify the use of OUTPUT_FILE now that it's a Path object.

Thanks again for working on this! 🎸

bmispelon · 2025-11-21T21:09:05Z

releases/management/commands/generate_release_roadmap.py

+    with open(OUTPUT_FILE, "w", encoding="utf-8") as f:
+        f.write(output_svg)


Now that OUTPUT_FILE is a Path object, this can be replaced with:

Suggested change

with open(OUTPUT_FILE, "w", encoding="utf-8") as f:

f.write(output_svg)

OUTPUT_FILE.write_text(output_svg)

https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_text

removed tools directory and done suggested changes

releases/management/commands/generate_release_roadmap.py

…p.py

bhargav-j47 · 2025-11-23T13:41:33Z

i have done suggested changes please check if any more changes are needed

bhargav-j47 and others added 4 commits November 8, 2025 19:06

added automatic release svg generation

84d684d

[pre-commit.ci] auto fixes from pre-commit.com hooks

06511ea

for more information, see https://pre-commit.ci

Update generate_release_roadmap.py

2213e0e

fixed colors

[pre-commit.ci] auto fixes from pre-commit.com hooks

1b18f70

for more information, see https://pre-commit.ci

sarahboyce reviewed Nov 16, 2025

View reviewed changes

sarahboyce mentioned this pull request Nov 16, 2025

Content: Automate Django Release Roadmap SVG and Add Template Safeguards for Missing Releases (#2297) #2303

Closed

bhargav-j47 and others added 7 commits November 17, 2025 22:17

Update tools/template.svg.jinja

0a42640

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>

Merge branch 'django:main' into release-imp

c4d691f

Update tools/generate_release_roadmap.py

4a49490

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

c9599a3

for more information, see https://pre-commit.ci

added suggested changes

6f75394

[pre-commit.ci] auto fixes from pre-commit.com hooks

8a06d6f

for more information, see https://pre-commit.ci

Update generate_release_roadmap.py

7c5aa13

sarahboyce reviewed Nov 19, 2025

View reviewed changes

bhargav-j47 and others added 3 commits November 19, 2025 19:13

making svg more similar to png and adding fade

5e140e9

[pre-commit.ci] auto fixes from pre-commit.com hooks

9feb2fc

for more information, see https://pre-commit.ci

update generate_release_roadmap.py

90d5ba3

bhargav-j47 added 2 commits November 19, 2025 20:50

improving fade

c791ec1

size changes to make svg similar to old png

c9a3e88

sarahboyce approved these changes Nov 19, 2025

View reviewed changes

sarahboyce requested a review from a team November 19, 2025 16:13

sarahboyce requested changes Nov 19, 2025

View reviewed changes

tools/generate_release_roadmap.py Outdated Show resolved Hide resolved

tools/generate_release_roadmap.py Outdated Show resolved Hide resolved

bhargav-j47 and others added 4 commits November 19, 2025 22:24

Update tools/generate_release_roadmap.py

23fb4b2

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>

Update tools/generate_release_roadmap.py

4500278

Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>

Merge branch 'django:main' into release-imp

460c01b

commiting latest svg

c4c15f6

sarahboyce approved these changes Nov 19, 2025

View reviewed changes

bmispelon reviewed Nov 19, 2025

View reviewed changes

djangoproject/templates/releases/download.html Show resolved Hide resolved

bmispelon reviewed Nov 19, 2025

View reviewed changes

bhargav-j47 and others added 4 commits November 20, 2025 22:18

updated og:image:type and appereance changes to match original png

2479366

[pre-commit.ci] auto fixes from pre-commit.com hooks

3a1d1b2

for more information, see https://pre-commit.ci

adding generate roadmap as management command in releases app

1c5c6c5

[pre-commit.ci] auto fixes from pre-commit.com hooks

5f6f840

for more information, see https://pre-commit.ci

bhargav-j47 requested a review from bmispelon November 20, 2025 17:44

minor visual changes

db1d6e7

bmispelon reviewed Nov 21, 2025

View reviewed changes

ulgens reviewed Nov 21, 2025

View reviewed changes

releases/management/commands/generate_release_roadmap.py Outdated Show resolved Hide resolved

bhargav-j47 added 2 commits November 22, 2025 16:32

removing tools directory and minor changes in generate_release_roadma…

421d607

…p.py

minor changes in generate_release_roadmap.py

81af293

bhargav-j47 requested a review from bmispelon November 23, 2025 13:35

		with open(OUTPUT_FILE, "w", encoding="utf-8") as f:
		f.write(output_svg)

	with open(OUTPUT_FILE, "w", encoding="utf-8") as f:
	f.write(output_svg)
	OUTPUT_FILE.write_text(output_svg)

Uh oh!

added automatic release svg generation #2327

Are you sure you want to change the base?

added automatic release svg generation #2327

Uh oh!

Conversation

bhargav-j47 commented Nov 8, 2025 • edited by sarahboyce Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sarahboyce left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bhargav-j47 commented Nov 18, 2025

Uh oh!

sarahboyce left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bhargav-j47 commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sarahboyce left a comment

Choose a reason for hiding this comment

Uh oh!

sarahboyce left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bmispelon Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

bmispelon Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

bmispelon Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

bmispelon left a comment

Choose a reason for hiding this comment

Uh oh!

bhargav-j47 commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sarahboyce commented Nov 21, 2025

Uh oh!

bmispelon left a comment

Choose a reason for hiding this comment

Uh oh!

bmispelon Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

bhargav-j47 Nov 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bhargav-j47 commented Nov 23, 2025

Uh oh!

Reviewers

Assignees

bhargav-j47 commented Nov 8, 2025 •

edited by sarahboyce

Loading

bhargav-j47 commented Nov 19, 2025 •

edited

Loading

bhargav-j47 commented Nov 20, 2025 •

edited

Loading