From e9e855a0f3707b1a07efa60fce765ab20256204c Mon Sep 17 00:00:00 2001 From: Andrew Janke Date: Wed, 3 Jan 2024 16:37:48 -0500 Subject: [PATCH] Reformat Changelog to common gem conventions Reformats the Changelog to match conventions in KeepAChangelog and what I see in some major gems. Renames CHANGES to CHANGELOG.md, switches its Markdown formatting to use "#" section headers instead of "------" underlines, removes "Version" from headings and uses ISO-style yyyy-mm-dd date format, rewords things to present/imperative tense like I use in commits, and break out some bugfix/feature subsections. --- CHANGES => CHANGELOG.md | 101 +++++++++++++++++---------------- doc-project/Developer-Guide.md | 18 +++--- man/index.html | 6 +- ronn-ng.gemspec | 6 +- 4 files changed, 70 insertions(+), 61 deletions(-) rename CHANGES => CHANGELOG.md (82%) diff --git a/CHANGES b/CHANGELOG.md similarity index 82% rename from CHANGES rename to CHANGELOG.md index 1689a7c..48607ff 100644 --- a/CHANGES +++ b/CHANGELOG.md @@ -1,76 +1,86 @@ -Ronn-NG CHANGES -=============== +# Ronn-NG CHANGELOG -Version 0.10.1 (in progress) ----------------------------- +## 0.10.1 (unreleased) This release is focused on bug fixes and updating library dependencies, to get Ronn-NG building and working correctly on recent Linux and macOS releases. Note: 0.10.1 is the first 0.10.x release, because Ronn-NG 0.10.0 does not exist. +### Features and Additions + * Switch to GitHub Flavored Markdown, fixing code block rendering () +* Bump Ruby to 2.7, gem deps to latest minor versions + +### Bug Fixes + * Revert `\[ci]` back to `\(bu)` () -* Minor fix to single-quote escaping () +* Fix single-quote escaping () * Elide HTML comments when producing roff output () * Remove non-portable `more -i` option () * Fix charset in HTML output's Content-Type () -* Bump to mustache 1.x -* Bump all the other RubyGems deps +* Bump Ruby to 2.7, gem deps to latest minor versions +* Fix test failure for angle-bracket items with namespace-like "foo:" prefixes () + * Inclusion of the "foo:" is now considered correct, matching current code behavior -Version 0.10.0 (never) ---------------------------- +### Internal + +* doc: Reformat Changelog to match common gem and keep-a-changelog conventions + +## 0.10.0 (never released) Doesn't exist due to a RubyGems publishing mistake. -Version 0.9.1 (2020 Apr 09) ---------------------------- +## 0.9.1 (2020-04-09) * Fix underlining issue () -Version 0.9.0 (2019 Dec 21) ---------------------------- +## 0.9.0 (2019-12-21) * Migrate to kramdown for the underlying Markdown library * Minor output formatting and documentation improvements -Version 0.8.2 (2019 Mar 5) --------------------------- +## 0.8.2 (2019-03-05) * Fixes packaging error in 0.8.1 -Version 0.8.1 (2019 Mar 5) --------------------------- +## 0.8.1 (2019-03-05) + +* Fix URL hyphenation bug () +* Fix ordered-list bustication. () -* Fixed URL hyphenation bug. () (apjanke) -* Fixed ordered-list bustication. () (apjanke) +## 0.8.0 (2018-12-25) -Version 0.8.0 (2018 Dec 25) ---------------------------- +### Features -* Added tables support. (apjanke) -* Lint & Rubocop fixes. (apjanke) -* Added --output-dir option. (apjanke) -* Support file names with periods in the name section. (apjanke) -* Migrated from Hpricot to Nokogiri. (apjanke) +* Add tables support. +* Add --output-dir option. +* Migrate from Hpricot to Nokogiri. -Version 0.7.4 (2018 Dec 22) ---------------------------- +### Bug Fixes -* Forked Ronn-NG from original Ronn. (apjanke) -* Minor bug fixes: #4, #5 (apjanke) +* Lint & Rubocop fixes +* Support file names with periods in the name section -Original Ronn CHANGES -===================== +## 0.7.4 (2018-12-22) -Version 0.7.3 (2010 June 24) ----------------------------- +* Forked Ronn-NG from original Ronn + +### Bug Fixes + +* Fix test for HTML meta elements (#4) +* Fix circumflex rendering (#5) + +## Original Ronn changelog + +The following sections are the changes from the original Ronn project, before Ronn-NG was forked from it. They were pulled in from its existing CHANGES file and reformatted. + +## 0.7.3 (2010-06-24) * Fixed a major bug in roff output due to overly aggressive doublequote escaping. Paragraphs and code blocks were not being displayed if they included a double-quote character. (rtomayko, pawelz) -Version 0.7.0 (2010 June 21) ----------------------------- +## 0.7.0 (2010-06-21) * HTML: Manual references (like 'grep(1)', 'ls(1)', etc.) are now hyperlinked based on a set of name -> URL mappings defined in an index.txt file. The index @@ -103,16 +113,14 @@ Version 0.7.0 (2010 June 21) * Performance improvements. Fixed a few cases where HTML was being reparsed needlessly, tuned dom selectors, ... (rtomayko) -Version 0.6.6 (2010 June 13) ----------------------------- +## 0.6.6 (2010-06-13) Small bug fix release fixes whitespace stripping between adjacent inline elements in roff output (adamv, rtomayko) -Version 0.6 (2010 June 13) --------------------------- +## 0.6 (2010-06-13) -Features: +### Features * HTML: New styling system: ronn --style=toc,print program.1.ronn @@ -170,7 +178,7 @@ Features: establish the default values of the --manual, --organization, and --date options (rtomayko) -Bugs: +### Bug Fixes * ROFF: Don't crash with empty preformatted blocks (sunaku) @@ -181,7 +189,7 @@ Bugs: * ROFF: All ['".] characters are backslash escaped in roff output. These characters are used for various roff macro syntax (rtomayko) -Deprecations, Obsoletions: +### Deprecations, Obsoletions * The ronn(1) command line interface has changed in ways that are not backward-compatible with previous versions of ronn. The --build option is @@ -211,8 +219,7 @@ Deprecations, Obsoletions: shipped with the latest version of rdiscount, however. (rtomayko, sunaku) -0.5 (2010 April 24) -------------------- +## 0.5 (2010-04-24) * Fixed a bug in roff output where multiple successive newlines were being collapsed into a single newline in preformatted output. @@ -223,9 +230,7 @@ Deprecations, Obsoletions: * The compatibility shims that allowed the ronn command to be invoked as "ron", and the ronn library to be required as "ron", have been removed. - -0.4 (2010 March 08) -------------------- +## 0.4 (2010-03-08) * Ron has been renamed "Ronn", including the "ronn" command and the "ronn" library. Compatibility shims are included in this release but will be removed diff --git a/doc-project/Developer-Guide.md b/doc-project/Developer-Guide.md index f67a56d..5c5f45a 100644 --- a/doc-project/Developer-Guide.md +++ b/doc-project/Developer-Guide.md @@ -3,28 +3,32 @@ ## Release checklist * Update the version in files - * ronn-ng.gemspec (update the release date, too) + * `ronn-ng.gemspec` (update the release date there, too) * `lib/ronn.rb` -* Update `CHANGES` with the release date +* Update `CHANGELOG.md` with the release date * Regenerate the man pages with `bundle exec rake man` * Run the tests one last time! `bundle exec rake test` * Commit the updated files * Tag the release: `git tag vX.Y.Z` * `git push --tags` * Create the Release on GitHub Releases -* Build and deploy the gem to RubyGems +* Build and publish the gem to RubyGems * `gem build ronn-ng.gemspec` * `gem push ronn-ng-.gem` -* TODO: Announce the release somewhere +* TBD: Announce the release somewhere + +TODO: Add instructions for prerelease/beta releases. After the release, start development on the next release: * Update the version in files - * ronn-ng.gemspec + * `ronn-ng.gemspec` * `lib/ronn.rb` -* Update `CHANGES` with a new section for the next release -* Regenerate the man pages again: `rake man` +* Update `CHANGELOG.md` with a new "unreleased" section for the new work +* Regenerate the man pages again + * `bundle exec rake man` * Commit and push + * Use commit message like "open development for next release" ## Setting up your dev environment diff --git a/man/index.html b/man/index.html index 22feac4..ece3ac1 100644 --- a/man/index.html +++ b/man/index.html @@ -48,7 +48,7 @@

Auxiliary

README, INSTALLING, - CHANGES, + CHANGELOG.md, LICENSE, AUTHORS

@@ -56,10 +56,10 @@

Auxiliary

Manuals

ronn(1)
-
manual authoring tool
+
manpage authoring tool
ronn-format(7)
-
markdown-based text format for authoring manpages
+
Markdown-based text format for authoring manpages

See Also

diff --git a/ronn-ng.gemspec b/ronn-ng.gemspec index 980f08b..41965da 100644 --- a/ronn-ng.gemspec +++ b/ronn-ng.gemspec @@ -7,7 +7,7 @@ Gem::Specification.new do |s| s.required_ruby_version = '>= 2.7' s.summary = 'Builds man pages from Markdown' - s.description = 'Ronn-NG builds manuals in HTML and Unix man page format from Markdown. Ronn-NG is a modern, maintained fork of the original Ronn.' + s.description = 'Ronn-NG builds manuals in Unix man page and HTML format from Markdown. Ronn-NG is a modern, maintained fork of the original Ronn.' s.homepage = 'https://github.com/apjanke/ronn-ng' s.license = 'MIT' @@ -17,13 +17,13 @@ Gem::Specification.new do |s| s.metadata = { 'bug_tracker_uri' => 'https://github.com/apjanke/ronn-ng/issues', 'source_code_uri' => 'https://github.com/apjanke/ronn-ng', - 'changelog_uri' => 'https://github.com/apjanke/ronn-ng/blob/main/CHANGES' + 'changelog_uri' => 'https://github.com/apjanke/ronn-ng/blob/main/CHANGELOG.md' } # = MANIFEST = s.files = %w[ AUTHORS - CHANGES + CHANGELOG.md INSTALLING.md LICENSE.txt README.md