Skip to content

Commit

Permalink
CHANGES: rename to CHANGES.md, no longer generated
Browse files Browse the repository at this point in the history
- 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 curl#14331
  • Loading branch information
bagder committed Aug 1, 2024
1 parent 12774f4 commit 8a9c227
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 118 deletions.
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ documentation:
- all:
- changed-files:
- any-glob-to-all-files:
- '{.github/workflows/badwords.yml,.github/workflows/man-examples.yml,.github/workflows/synopsis.yml,.github/scripts/badwords.*,.github/scripts/cd2cd,.github/scripts/cd2nroff,.github/scripts/cdall.pl,.github/scripts/nroff2cd,.github/scripts/verify-examples.pl,.github/scripts/verify-synopsis.pl,**/*.md,**/*.txt,**/*.1,CHANGES,docs/**,LICENSES/**,README,RELEASE-NOTES,scripts/cd*}'
- '{.github/workflows/badwords.yml,.github/workflows/man-examples.yml,.github/workflows/synopsis.yml,.github/scripts/badwords.*,.github/scripts/cd2cd,.github/scripts/cd2nroff,.github/scripts/cdall.pl,.github/scripts/nroff2cd,.github/scripts/verify-examples.pl,.github/scripts/verify-synopsis.pl,**/*.md,**/*.txt,**/*.1,CHANGES.md,docs/**,LICENSES/**,README,RELEASE-NOTES,scripts/cd*}'
- all-globs-to-all-files:
# negative matches
- '!**/CMakeLists.txt'
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
/builds/
/stats/
__pycache__
CHANGES.dist
Debug
INSTALL
Makefile
Expand Down
7 changes: 0 additions & 7 deletions CHANGES

This file was deleted.

12 changes: 12 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!--
Copyright (C) Daniel Stenberg, <[email protected]>, et al.
SPDX-License-Identifier: curl
-->

In a release tarball, check the RELEASES-NOTES file for what was done in the
most recent release. In a git check-out, that file mentions changes that have
been done since the previous release.

See the online [changelog](https://curl.se/changes.html) for the edited and
human readable version of what has changed in different curl releases.
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ PLAN9_DIST = plan9/include/mkfile \
plan9/src/mkfile.inc \
plan9/src/mkfile

EXTRA_DIST = CHANGES COPYING maketgz Makefile.dist curl-config.in \
EXTRA_DIST = CHANGES.md COPYING maketgz Makefile.dist curl-config.in \
RELEASE-NOTES buildconf libcurl.pc.in $(CMAKE_DIST) $(VC_DIST) \
$(WINBUILD_DIST) $(PLAN9_DIST) lib/libcurl.vers.in buildconf.bat \
libcurl.def Dockerfile
Expand Down
1 change: 0 additions & 1 deletion REUSE.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ SPDX-PackageDownloadLocation = "https://curl.se/"
[[annotations]]
path = [
".mailmap",
"CHANGES",
"docs/FAQ",
"docs/INSTALL",
"docs/KNOWN_BUGS",
Expand Down
3 changes: 0 additions & 3 deletions maketgz
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,6 @@ else
automake --include-deps Makefile >/dev/null
fi

echo "produce CHANGES"
git log --pretty=fuller --no-color --date=short --decorate=full -1000 | ./scripts/log2changes.pl > CHANGES.dist

echo "produce RELEASE-TOOLS.md"
./scripts/release-tools.sh "$timestamp" "$version" > docs/RELEASE-TOOLS.md.dist

Expand Down
2 changes: 1 addition & 1 deletion packages/OS400/makefile.sh
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ fi
# Copy some documentation files if needed.

for TEXT in "${TOPDIR}/COPYING" "${SCRIPTDIR}/README.OS400" \
"${TOPDIR}/CHANGES" "${TOPDIR}/docs/THANKS" "${TOPDIR}/docs/FAQ" \
"${TOPDIR}/CHANGES.md" "${TOPDIR}/docs/THANKS" "${TOPDIR}/docs/FAQ" \
"${TOPDIR}/docs/FEATURES" "${TOPDIR}/docs/SSLCERTS.md" \
"${TOPDIR}/docs/RESOURCES" "${TOPDIR}/docs/VERSIONS.md" \
"${TOPDIR}/docs/HISTORY.md"
Expand Down
103 changes: 0 additions & 103 deletions scripts/log2changes.pl

This file was deleted.

0 comments on commit 8a9c227

Please sign in to comment.