Skip to content
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.

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

Python version status: show when bugfix releases become security releases. #1529

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nedbat
Copy link
Member

@nedbat nedbat commented Mar 12, 2025

This adds a yellow security tail to the green bugfix bars:
image

The transition date is a fixed two years after the first release. The release schedule PEPs don't indicate a specific date.


📚 Documentation preview 📚: https://cpython-devguide--1529.org.readthedocs.build/versions/

@JelleZijlstra
Copy link
Member

I feel this makes it more confusing. The color of each bar is supposed to represent the branch's current status, not its status at some particular time. For example, your version makes it seem like 3.11 was always in security-only mode, instead of marking it as bugfix for the first few years.

We could make an alternative design where we switch fully to this PR's approach, but that would require for example that we color everything after the EOL as red for end-of-life on every branch.

Comment on lines +80 to +86
M{{ left_x + radius_value }},{{ recty }}
Q{{ left_x }},{{ recty }} {{ left_x }},{{ recty + radius_value }}
V{{ recty + height - radius_value }}
Q{{ left_x }},{{ recty + height }} {{ left_x + radius_value }},{{ recty + height }}
H{{ middle_x }}
V{{ recty }}
Z
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find this rather confusing.
Once the final style is decided, would you mind me simplifying & adding comments? Unless you want to do it of course.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course it's fine to simplify and comment. One way to simplify is to forgo the rounded corners. This <path> element was the only way to give it two rounded corners and two square corners.

@encukou
Copy link
Member

encukou commented Mar 13, 2025

We had some real-time brainstorming; feel free to pick ideas/code from main...encukou:devguide:split-status-bars

(Or delegate to me if you wish.)

@merwok
Copy link
Member

merwok commented Mar 13, 2025

Jelle has a good point. When you think about it, the original design is a little strange in combining a time chart and current status in label and colour.

Python’s current timeline shows status relative to time of viewing.
Another way is Django’s timeline, with time-relative status and a current date line: django release timeline

On the other hand, the change proposed is useful. Maybe it would be less jarring if the other 3 labels with «security» also showed a «bugfix» segment? Then it would be uniform for the releases that are not EOL or feature.

@merwok
Copy link
Member

merwok commented Mar 13, 2025

Can you show the results of your version Petr?

@encukou
Copy link
Member

encukou commented Mar 13, 2025

I'm updating my branch at times; the commit 3a4fe83 renders as:

image

with the full chart below the tables (click to expand)

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants