You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use case: Downstream user documenting upgrading ruff
Assume a downstream ruff user is trying to document upgrading from 0.0.250 to 0.0.270 - it's very difficult to create a single, permanent link to show all changes.
Benefits of a single CHANGES.md file
Simply using CHANGES.md file would be most convenient for users downstream, which can then:
scroll up and down between release
ctrl-f in the file across all changes
link to:
anchor / release inside
highlighted text
Maintainer / project benefits:
Can be git tag'd directly to a release
Not locked into GitHub
Earlier thread
#2083 was closed, but didn't do anything to alleviate the core issue: GitHub releases obfuscates critical information by breaking the changelog into a "hide and seek" - making it a cumbersome task to track changes over multiple releases.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hi, Thank you for the project!
Current existing concepts in project
Ruff does keep a
BREAKING_CHANGES.md
(v0.0.280
), having aCHANGES.md
makes it highly convenient.Example: Open spec
keep a changelog: https://keepachangelog.com/en/1.1.0/
Use case: Downstream user documenting upgrading
ruff
Assume a downstream
ruff
user is trying to document upgrading from 0.0.250 to 0.0.270 - it's very difficult to create a single, permanent link to show all changes.Benefits of a single
CHANGES.md
fileSimply using
CHANGES.md
file would be most convenient for users downstream, which can then:Maintainer / project benefits:
git tag
'd directly to a releaseEarlier thread
#2083 was closed, but didn't do anything to alleviate the core issue: GitHub releases obfuscates critical information by breaking the changelog into a "hide and seek" - making it a cumbersome task to track changes over multiple releases.
Beta Was this translation helpful? Give feedback.
All reactions