Skip to content
Documentation

    Changelog Description Field (optional)

    Hub generates descriptions for Jira work from its title and internal description. By default, Hub stores that description in issue properties, which keeps it available to Hub without changing the issue layout.

    Add the optional Changelog description field when people need to see and edit the generated copy directly on the Jira work item. The field must be available on every work type you want to include in release notes; otherwise Hub falls back to the standard storage for work where the field is unavailable.

    Choose the right setup

    Section titled “Choose the right setup”

    Use the custom field when product managers, support teams, or reviewers work primarily in Jira and need the release-note copy alongside the source work. Leave the default storage in place when generated descriptions are only reviewed in Hub and you do not want to change issue screens.

    Configuring the description field

    Section titled “Configuring the description field”

    Select the type of project that contain the issues for your release notes and follow the instructions below to set up the custom field.

    To add the field to your issue types:

    1. In the project sidebar, click Project settings > Fields.
    2. Search for Changelog description.
      1. If the field is not available, click the Add field button.
      2. Select the Changelog description field from the list.
      3. Click the Add 1 field button.
    3. Use the Work types dropdown to select the work types where you want to add the field.
    4. Search for the Changelog description field in the Fields sidebar on the right.
    5. Drag the Changelog description field into the description fields section.
    6. Click Save changes.

    Repeat these steps for each work item type in your project.

    For more detail see: Customize an issue’s field in team-managed projects.