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

Rethink release changelogs #1147

Closed
Cyberboss opened this issue Nov 7, 2020 · 2 comments · Fixed by #1632
Closed

Rethink release changelogs #1147

Cyberboss opened this issue Nov 7, 2020 · 2 comments · Fixed by #1632
Assignees
Labels
CI/CD IT'S NOT A PHASE MOM, IT'S A REAL SPECIALIZATION Help Wanted Looking for outside answers to uncertain problems Work In Progress Issue being actively worked on
Milestone

Comments

@Cyberboss
Copy link
Member

The issue we have is (specifically configuration) changelogs are incremental. Therefore, if someone jumps 3 minor versions in one update and we only include the latest changelog, they may miss important information that warrants action on their end.

But look at the size of these release notes, it's getting ridiculous https://github.com/tgstation/tgstation-server/releases/tag/tgstation-server-v4.6.0

@Cyberboss Cyberboss added CI/CD IT'S NOT A PHASE MOM, IT'S A REAL SPECIALIZATION Help Wanted Looking for outside answers to uncertain problems Design Research required into the best way to implement or fix a given issue labels Nov 7, 2020
@Cyberboss
Copy link
Member Author

@alexkar598 suggested only including 3 minor versions. A step in the right direction, but still doesn't fully solve the issue

@Cyberboss
Copy link
Member Author

Cyberboss commented Jun 19, 2023

We need to generate a full changelog.yml that contains note for versions as far back as we can get them and is posted as an artifact in every release. #1557

We need categories for each release type (TGS, HTTP API, DMAPI, EACH Nuget, Package, Web CP, Host Watchdog)

We need to auto-fill some type specific fields i.e. debian/changelog Nuget PackageReleaseNotes

It should be pointed at by `debian/

@Cyberboss Cyberboss added Backlog Issue to be scheduled for addressing and removed Design Research required into the best way to implement or fix a given issue labels Jun 19, 2023
@Cyberboss Cyberboss added this to the Backlog milestone Jun 19, 2023
@Cyberboss Cyberboss pinned this issue Jun 20, 2023
@Cyberboss Cyberboss added Ready Issue ready to be addressed and removed Backlog Issue to be scheduled for addressing labels Jul 23, 2023
@Cyberboss Cyberboss modified the milestones: Backlog, v5.14.0 Jul 23, 2023
@Cyberboss Cyberboss self-assigned this Aug 15, 2023
@Cyberboss Cyberboss added Work In Progress Issue being actively worked on and removed Ready Issue ready to be addressed labels Aug 15, 2023
@Cyberboss Cyberboss unpinned this issue Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD IT'S NOT A PHASE MOM, IT'S A REAL SPECIALIZATION Help Wanted Looking for outside answers to uncertain problems Work In Progress Issue being actively worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant