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

Remove CHANGELOG.md #756

Merged
merged 1 commit into from
Jun 2, 2023
Merged

Remove CHANGELOG.md #756

merged 1 commit into from
Jun 2, 2023

Conversation

ctubbsii
Copy link
Member

@ctubbsii ctubbsii commented Jun 1, 2023

Remove the CHANGELOG file because it is a pain to manually edit, is easy to be incorrect, and does not add value beyond the value inherent in the source control repository (git log).

@ctubbsii ctubbsii added this to the 2.24.0 milestone Jun 1, 2023
@ctubbsii ctubbsii self-assigned this Jun 1, 2023
README.md Outdated Show resolved Hide resolved
Remove the CHANGELOG file because it is a pain to manually edit,
is easy to be incorrect, and does not add value beyond the value
inherent in the source control repository (git log).
@ctubbsii ctubbsii merged commit faf7b80 into revelc:main Jun 2, 2023
@ctubbsii ctubbsii deleted the remove-changelog branch June 2, 2023 15:12
@hazendaz
Copy link
Member

hazendaz commented Jun 2, 2023

I think Renovate was reading from there. Or at least appeared to be doing so. See hazendaz/base-parent#669. But I think the change log in general was probably in wrong order where latest should be at top not bottom and depending if it was really reading there or something else since it noted it differently than you have the latest release posted. Most repos I've worked though don't have a change log like that especially smaller ones like this. And either some combination of marking it under github releases or milestones are used. Most often I find myself going right to the releases section anyways on projects to read in more detail and if that isn't used i typically just compare versions and look at history if its needed.

@hazendaz
Copy link
Member

hazendaz commented Jun 2, 2023

This is how renovate was showing...

Release Notes
revelc/formatter-maven-plugin
[v2.23.0](https://togithub.com/revelc/formatter-maven-plugin/blob/HEAD/CHANGELOG.md#ver-2230)

==========

    Support Eclipse 2023-03 (4.27, JDT 3.33) - requires jdk 11

@hazendaz
Copy link
Member

hazendaz commented Jun 2, 2023

so guess that answers that. it was looking into the changelog.

@hazendaz
Copy link
Member

hazendaz commented Jun 2, 2023

But I don't see much of a loss there. It didn't exactly make that jump out. Most PRs from Renovate do. That one was hidden in a section that had to be opened to see and besides it links back to the repo as well and typically our only reason for release is almost always just new eclipse versions. If anything, I'd use the Release section and tag the release with anything of note there in similar way. I think that can also be automated to pull milestones and do automatigically but I've not done that myself. I think spotbugs repo works that way.

@hazendaz
Copy link
Member

See #844 as its very hard to understand and we need something.

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.

2 participants