Related articles & videos:

In this article, we'll review the options to introduce a commit, commit group, or Jira ticket into the stream of changes that a Snap Changelog opens to the desired audience.

To create an image that includes your recent tickets and commits, you first need to opt in to Changelog publishing when you set up your Snap Changelog:

open_in_new

When setting up a Snap Changelog the "Show Changelog" options need to allow publishing, with a chosen length

Once you have chosen "Yes," the image preview will show the highest Diff Delta tickets and commits from the time range of the Snap Changelog. However, once your Snap Changelog has been published (so it can be viewed by the outside world),

The only commits or issues that will be shown in the Changelog section are those that have a line in the commit message that begins with #publish or #pub, unless you choose "Publish every ticket & large project"

linkConfiguring your Snap Changelog

Upon clicking to create a Snap Changelog, and later if you visit Settings -> Snap Changelogs, you can gain access to a myriad of charts ("Snapshots" or "Snaps") that can preface the changelog portion of your Snap Changelog:

open_in_new

Many charts are available when configuring a Snap Changelog

We are not yet documenting every option individually, because we expect to continue adding new options (or hiding options) as requested by users. If we are doing our job right, every option should be either self-explanatory or have an adjacent tooltip available when interacting with the form (although the tooltips obviously aren't available when hovering on the image in this help page)

linkExamples of publishing issues and commits

To publish an issue, you need to reference the issue after starting a line with #pub.

linkPublishing an issue

open_in_new

A commit message that will publish (only) the title of GC-1929 to the Work Log since the only text on the #pub line is the ticket identifier

In this example, the first line of the commit message is not published. The only content that will be published to the Snap Changelog is the title of the issue that was referenced on the line that starts with #pub:

open_in_new

GC-1929 was the identifier for a ticket in Jira that had the title "Allow developers to embed GC stats into Github Profile." Including the #pub GC-1929 message from above will result in a line like this one (with no specific commit details) showing in the Work Log

To include some implementation details alongside the ticket title, the developer can add details after identifying the ticket:

open_in_new

A commit message with an issue reference and some implementation text that will be shown in the Work Log

Will lead to the following Changelog entry:

open_in_new

Characters from published commit message are visible below the issue title. The truncation point depends on the Snap Changelog size.

If the developer goes on continue publishing commits related to this issue, up to three messages may be included below the ticket title. Here is the Changelog with two messages published:

open_in_new

linkPublishing a commit

Sometimes you aren't working with an issue tracker, or you want to publish details about a commit that doesn't refer to a ticket. In this case, you can simply start a line with #publish or #pub without including a ticket identifier:

open_in_new

A commit message that will publish an individual commit to the Work Log

Leads to the following changelog entry:

open_in_new

Work Log entry showing an individual published commit

This works even if the #publish line is one among many:

open_in_new

Which generates the following changelog:

open_in_new

link