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

CHANGES: rename to CHANGES.md, no longer generated #14331

Closed
wants to merge 3 commits into from

Conversation

bagder
Copy link
Member

@bagder bagder commented Aug 1, 2024

  • scripts/log2changes.pl was not included in release tarballs, which broke reproducible builds

  • since log2changes uses git to generate the contents, it makes it difficult to generate the same contents later (it would need to be fixed)

  • the CHANGES file has outlived its purpose. the main changes are in the RELEASE-NOTES, the rest are better tracked directly using git or on GitHub

@icing
Copy link
Contributor

icing commented Aug 1, 2024

Since CHANGES is such a standard location to look for, should we include one that say "look at RELEASE-NOTES"?

vszakats added a commit to curl/curl-for-win that referenced this pull request Aug 1, 2024
curl tarballs since 8.8.0 are reproducible, and any file is fine as
a timestamp reference. `CHANGES` may be dropped from future tarballs,
so switch to one that's there to stay.

curl/curl#14331
@bagder
Copy link
Member Author

bagder commented Aug 1, 2024

Since CHANGES is such a standard location to look for, should we include one that say "look at RELEASE-NOTES"?

A reasonable note to add, yes.

- scripts/log2changes.pl was not included in release tarballs, which broke
  reproducible builds

- since log2changes uses git to generate the contents, it makes it difficult
  to generate the same contents later (it would need to be fixed)

- the CHANGES file has outlived its purpose. the main changes are in the
  RELEASE-NOTES, the rest are better tracked directly using git or on GitHub

- put a fixed CHANGES.md in there instead pointing out where the info lives
  now

Closes #14331
@github-actions github-actions bot added the CI Continuous Integration label Aug 1, 2024
@bagder
Copy link
Member Author

bagder commented Aug 1, 2024

@vszakats The curl-for-win jobs fail here because it seems they access ./CHANGES which I am now renaming to CHANGES.md but I am also making it less relevant. Maybe we should just skip that now in curl-for-win?

vszakats added a commit to curl/curl-for-win that referenced this pull request Aug 1, 2024
@vszakats
Copy link
Member

vszakats commented Aug 1, 2024

I did few minutes after you opening the PR, but forgot it's also in the distro pack, thanks for the ping!

Should be fine now after curl/curl-for-win@fa22468.

@bagder bagder changed the title maketgz: drop CHANGES from release tarballs CHANGES: rename to CHANGES.md, no longer generated Aug 1, 2024
bagder added a commit to curl/curl-for-win that referenced this pull request Aug 1, 2024
Syncing up with curl/curl#14331 which renames
the `CHANGES` file to `CHANGES.md` and no longer generates it in
releases.
@bagder
Copy link
Member Author

bagder commented Aug 1, 2024

Thanks!

CHANGES.md Show resolved Hide resolved
@bagder bagder closed this in 8a9c227 Aug 1, 2024
@bagder bagder deleted the bagder/rm-changes branch August 1, 2024 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration dist script
Development

Successfully merging this pull request may close these issues.

3 participants