Skip to content

Remove the CHANGELOG#909

Open
RobLoach wants to merge 6 commits intoImmediate-Mode-UI:masterfrom
RobLoach:remove-changelog
Open

Remove the CHANGELOG#909
RobLoach wants to merge 6 commits intoImmediate-Mode-UI:masterfrom
RobLoach:remove-changelog

Conversation

@RobLoach
Copy link
Contributor

@RobLoach RobLoach commented Mar 7, 2026

Fixes #908

@rswinkle
Copy link
Contributor

rswinkle commented Mar 8, 2026

I haven't actually checked it out and compiled it but it looks good to me.

@@ -1,366 +0,0 @@
/// ## Changelog
Copy link
Contributor

@sleeptightAnsiC sleeptightAnsiC Mar 8, 2026

Choose a reason for hiding this comment

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

I thought we would only remove it from being included to the amalgamation, but still keep the src/CHANGELOG checked into the repo (maybe with note that "changelog has been discontinued") so people can easily reason about it. This file entirely disappearing could cause some confusion (?)

Copy link
Contributor Author

@RobLoach RobLoach Mar 8, 2026

Choose a reason for hiding this comment

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

Naw, remove it all. Once we get steady releases going, accurate changelogs will be found here:
https://github.com/Immediate-Mode-UI/Nuklear/releases

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we archive it on a wiki page at least?

I feel a bit uneasy the file updated for past 10 years just disappears

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point. I'll leave the changelog file there with a link to archives and new one.

Copy link
Contributor

@sleeptightAnsiC sleeptightAnsiC Mar 8, 2026

Choose a reason for hiding this comment

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

Thanks!

I don't mind the content of this file disappearing. I just want the file itself to stay in same place, so people can find anything meaningful when searching for it.

If you wipe everything and only leave a message like so:

The changelog was discontinued and archived.
Please see: [link to the wiki page with short explanation and archived version]

^ I think this should be enough to avoid confusion.

Perhaps, the best would be to keep this note included into amalgamation, since I only imagine people using the amalgamation to ever care about such things, but I won't pressure about this one.

Copy link
Contributor

Choose a reason for hiding this comment

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

Feel free to resolve. All my points were added.

/// - [y]: Minor version with non-breaking API and library changes
/// - [z]: Patch version with no direct changes to the API
/// The CHANGELOG can be found for each release in:
/// https://github.com/Immediate-Mode-UI/Nuklear/releases
Copy link
Contributor

@sleeptightAnsiC sleeptightAnsiC Mar 10, 2026

Choose a reason for hiding this comment

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

This site is empty right now. Are you planning to tag a release any time soon? I don't think it's a big deal though, even if it stays empty for several weeks. Just asking what's the plan here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct, it won't have anything until we start making those releases.

Copy link
Contributor

@sleeptightAnsiC sleeptightAnsiC left a comment

Choose a reason for hiding this comment

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

This is good as it is.

I don't believe we can do anything better. If someone's workflow will ever break, we will figure out how to address it later. The changelog wasn't properly updated for years, so no one should depend on it anyway.

@@ -30781,369 +30781,11 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args)

/// ## Changelog
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none
Copy link
Contributor

Choose a reason for hiding this comment

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

(same as above)

Suggested change
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Co-authored-by: sleeptightAnsiC <91839286+sleeptightAnsiC@users.noreply.github.com>
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.

Remove the CHANGELOG

3 participants