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

Don't add date to SDK changelog entry headers #56999

Open
parlough opened this issue Oct 31, 2024 · 0 comments
Open

Don't add date to SDK changelog entry headers #56999

parlough opened this issue Oct 31, 2024 · 0 comments
Labels
area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes.

Comments

@parlough
Copy link
Member

Problem

Currently, once a release is cut (or sometime after the fact), the date is added to the header element for that release. For example, ## 3.5.0 became ## 3.5.0 - 2024-08-06. This breaks existing links to the pre-existing header and also prevents automatic determination of the fragment for a specific release. Specifically, this has caused broken links on dart.dev a few times. More often if the date is updated on the main branch later on.

Solution

As GitHub doesn't have the way of specifying a specific fragment for a header, instead of modifying the header, place the date separately. There are many options, but something simple like the following could work.

## 3.5.0

**Released on:** 2024-08-06

### Language

// ....

@athomas @itsjustkevin

@parlough parlough added the area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. label Oct 31, 2024
MaryaBelanger pushed a commit to dart-lang/site-www that referenced this issue Oct 31, 2024
Resolves #6181

I'll open an issue on the SDK about avoiding this. **Edit:**
dart-lang/sdk#56999
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes.
Projects
None yet
Development

No branches or pull requests

1 participant