TIDY_CHANGELOG(1)

πŸŽ€ NAME πŸŽ€

okay bestie, welcome to TIDY_CHANGELOG(1) β€” this is the page for tidy_changelog, and it's literally the command-line tool for CPAN::Changes. yes, that's the whole job and it does it gorgeously πŸ’…


🌸 SYNOPSIS 🌸

the entire vibe, in one line:

$ tidy_changelog Changelog

πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the tea β˜• β€” tidy_changelog takes a changelog file, parses it using CPAN::Changes, and prints out the resulting output. that's it, that's the whole main character arc ✨

and if you don't hand it a file? no stress, bestie. the program will look around and see if there's one file in the current directory beginning by change (case-insensitive) and, if so, assume it to be the changelog. it's giving "I'll find it myself" energy πŸ•΅οΈβ™€οΈπŸ’–


πŸ‘‘ ARGUMENTS πŸ‘‘

  • --next β€” if you pass this, it assumes there's a placeholder header for an upcoming next release. the placeholder token itself is given via --token πŸ‘€
  • --token β€” the regular expression used to detect the token for an upcoming release, but only if --next is used. if you don't explicitly give one, it defaults to "\{\{\$NEXT\}\}" β€” yes, exactly that, escaping and all, don't come for me 🫢
  • --headers β€” if given, it only prints out the release header lines, without any of the changes. just the headlines, none of the gossip πŸ™ˆ
  • --reverse β€” prints the releases in reverse order (from the oldest to latest). so like, chronological order. timeline unbothered 🌈
  • --check β€” only checks if the changelog is formatted properly using the changes_file_ok function of Test::CPAN::Changes. it's the vibe check, fr fr βœ…
  • --help β€” this help πŸ’œ

and that's the whole page, bestie 🫢 this lil legend lives in the User Contributed Perl Documentation section, ships with perl v5.42.0, and was dated 2025-07-25 β€” so go forth and make your changelogs iconic πŸ‘‘βœ¨πŸ’–

πŸ“¦ where this page comes from