Creating a changelog entry with changelog-management

by gerph 11 months ago

macOS ◆ xterm-256color ◆ fish 284 views

The changelog management tool allows you to create change logs for individual branches, and later collate them into a master change log at release time. This video shows the process of creating a changelog entry for a new branch.

Each changelog entry is created in a separate file with a standard structure - following the https://keepachangelog.com/ style. The sub-command edit will launch your editor with the template to fill in, or the prior change on this branch. To create the record of the change, the relevant section (‘Fixed’ in this instance) is updated to explain what has been changed. When you leave the editor, the change is staged for commit.

The current changes, which may incorporate many branches, can be displayed with the sub-command current. This reads all the current changes and displays them in a unified view showing the state of this release. In this instance, the change can be seen listed alongside all the changes that have been merged from other branches.

When you’re ready to release, the collate sub-command (not shown) can be used to store the state of the release in a separate file, and clear out the ‘current’ directory of files, ready for the next release.

At any time, the full changelog, showing all release notes, can be generated with the sub-command full-changelog.

Each change is stored in a separate file, named for the branch. Because these files are separate, when it comes time to merge the branch to the main line, there will be no conflicts - which would be the case if a single changelog file were modified on each branch.

More by gerph

Playing Snake with Pyromaniac 00:46

by gerph 5 years ago

lsg - ls with git information 00:25

by gerph 6 years ago

Git client on RISC OS! (Fake... but still cute) 00:21

by gerph 4 years ago

Loading the Internet module from StackBeta5 02:05

by gerph 2 years ago

See all

You can download this recording in asciicast v2 format, as a .cast file.

Download

Replay in terminal

You can replay the downloaded recording in your terminal using the asciinema play command:

asciinema play 630221.cast

If you don't have asciinema CLI installed then see installation instructions.

Use with stand-alone player on your website

Download asciinema player from the releases page (you only need .js and .css file), then use it like this:

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" type="text/css" href="asciinema-player.css" />
</head>
<body>
  <div id="player"></div>
  <script src="asciinema-player.min.js"></script>
  <script>
    AsciinemaPlayer.create(
      '/assets/630221.cast',
      document.getElementById('player'),
      { cols: 112, rows: 24 }
    );
  </script>
</body>
</html>

See asciinema player quick-start guide for full usage instructions.

While this site doesn't provide GIF conversion at the moment, you can still do it yourself with the help of asciinema GIF generator utility - agg.

Once you have it installed, generate a GIF with the following command:

agg https://asciinema.org/a/630221 demo.gif

Or, if you already downloaded the recording file:

agg demo.cast demo.gif

Check agg --help for all available options. You can change font family and size, select color theme, adjust speed and more.

See agg manual for full usage instructions.