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

add regressions to changelog (NEWS.md) #49883

Merged
merged 7 commits into from
Jun 22, 2023

Conversation

aplavin
Copy link
Contributor

@aplavin aplavin commented May 18, 2023

Following recent slack discussion, https://julialang.slack.com/archives/C67910KEH/p1683570942857959.

Brief summary of that:

Would it make sense to add known regressions to release notes (NEWS.md)? For 1.9 vs 1.8, I've experienced two performance regressions myself, and seen another one discussed:
<...>
Surely there are more, but how can users become aware of them?

Seems reasonable to me; I would want to know about known regressions in a release if I was considering whether to update or not

References issues: #48612 (mine) #49332 (@pablosanjose) #48217 (@Moelf). Feel free to append more, or give more details!

NEWS.md Outdated Show resolved Hide resolved
@KristofferC
Copy link
Sponsor Member

The tone of these bullet points feels off to me and the descriptions are also much more general than the actual concrete issue. I think it is best to just link to the issues without trying to summarize them because any such attempt will lose too much details.

Something like:

  • The following regressions have been identified: [#48612], [#49332]

@aplavin
Copy link
Contributor Author

aplavin commented May 19, 2023

For a user considering updating his perfectly working code to a new julia version, regressions are as, or even more important than new features.
Features are described in NEWS inline, as short summaries with links to relevant issues/PRs - clearly, it's considered useful to have a summary at a glance. Should make sense to follow the same format for regressions.

Sorry if the tone sounds off, that was my crude attempt at making issue titles sound reasonable as bullet points. As a non-native speaker, I would appreciate any improvements here.

NEWS.md Outdated
-----------

* Precompilation takes significantly longer, 2x-3x compilations slowdowns are common
* Some type-unstable code runs orders of magnitude slower ([#48612])
Copy link
Contributor

Choose a reason for hiding this comment

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

Quoting myself from slack:

Remember to add the improvement back in the release notes of 1.10 too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know how to make PR with changes to two branches at once

@aplavin
Copy link
Contributor Author

aplavin commented Jun 1, 2023

bump...
What remains to be done on my side to add this?

@KristofferC
Copy link
Sponsor Member

The set of regressions in a release is a moving target since new ones can be found at any point. Therefore, I don't think it makes sense to store this information in a place that can not be mutated. How about adding a GitHub issue label (e.g. "regression 1.9") and linking to the list of such issues from this place?

@KristofferC
Copy link
Sponsor Member

Concretely: https://github.com/JuliaLang/julia/issues?q=+label%3A%22regression+1.9%22+

@aplavin
Copy link
Contributor Author

aplavin commented Jun 15, 2023

Thanks @KristofferC, that's a nice suggestion! Implemented by adding a link to news.md.
What I don't understand is how to mark an issue as a regression. For example, I reported one more (#50130), but don't see how to add a label there.

NEWS.md Outdated Show resolved Hide resolved
Co-authored-by: Kristoffer Carlsson <kcarlsson89@gmail.com>
@aplavin
Copy link
Contributor Author

aplavin commented Jun 21, 2023

Gentle bump...

NEWS.md Outdated Show resolved Hide resolved
@IanButterworth IanButterworth added the status:merge me PR is reviewed. Merge when all tests are passing label Jun 21, 2023
@IanButterworth IanButterworth merged commit 13751df into JuliaLang:release-1.9 Jun 22, 2023
5 checks passed
@IanButterworth IanButterworth removed the status:merge me PR is reviewed. Merge when all tests are passing label Jun 22, 2023
@aplavin
Copy link
Contributor Author

aplavin commented Jun 26, 2023

@KristofferC so how to mark regression issues for them to appear in the list?
Found these unmarked ones from a cursory search:
#49935
#49241
#50073
#50130
#49545
#50110
#49756
#49697

@aplavin aplavin deleted the patch-8 branch June 26, 2023 09:17
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.

None yet

4 participants