Releases

Releases are non-editable copies, or snapshots, of maps or topics with all dependencies at their current state.

Interface

Note: Depending on your CCMS configuration, some operations may be restricted to Administrators and users with specific permissions.
Releases

The Releases tab enables you to do the following:

  • Create new releases
  • Deprecate releases
  • Localize releases
  • Branch releases
  • Download releases
  • Publish releases
  • Preview releases

Guidelines

Keep the following guidelines in mind when working with releases:

  • Before creating a release, check the content for errors. You can do that by publishing your content and verifying what the output looks like.
  • Establish a naming convention for releases. Once you create a release, you cannot change its name.
  • The resources in releases do not count against your content object limits.

Example

Figure 1. Releases.

The following example shows three releases of a product guide created from the master branch. The releases cannot be edited.

Versioning with releases

Create a Release

You can create a release of a map or a topic to archive the content in its current state.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Click Create Release.
    Create Release UI
  3. In the Create Release dialog, do the following:
    1. Fill in the Release name field.
      Tip: We recommend making the release names consistent for each set of documentation and representative of how the document progressed from one release to another. For example, the first release for a a specific product can be called "Product A Release 1.0", then the second one "Product A Release 1.1", and so on.
    2. Optional: Fill in the Notes field.
      Note: Here you can add additional details and information about a specific release.
    3. Click Create.
Release example

Deprecate and Restore a Release

You can deprecate a release that you no longer need or want to maintain. Deprecated releases are not permanently removed. They are moved to a separate section and can be restored at any time.
  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. To deprecate a release, hover over the release that you want to deprecate and click Deprecate.
    Deprecated releases are listed below the active releases.
    Deprecated Release example
  3. To reactivate a deprecated release, hover over a deprecated release and click Undeprecate.

Localize a Release

We recommend using released content for localization. The localized content is associated with a given release and does not show up for the source map.
  • Release a map or a topic. See Create a Release.
    Remember: You must use DITA maps and not standalone DITA topics to localize content with XTM.
In the Releases pane, do the following:
  1. Hover over a release and click Localize.
    Release example
In the Localization Manager, do the following:
  1. From the Job type drop-down menu, select a localization package type.
    For more information on the available localization packages, see View a Release.
  2. For XLIFF packages, do the following:
    1. Fill in the Project Notes field for the localization team.
    2. Optional: If needed, modify the Manager field.
    3. In the Pick Target Locales field, add target languages.
    4. Optional: If you want to include existing translations, select the Include existing translations check box.
  3. For Media packages, do the following:
    1. Fill in the Project Notes field for the localization team.
    2. Optional: If needed, modify the Manager field.
    3. If you are localizing the released content for the first time, from the Include field, select All Media.
    4. If you have already localized the released content, from the Include field, select Only Changed Media.
    5. In the Pick Target Locales field, add target languages.
  4. For Source packages, do the following:
    1. Fill in the Project Notes field for the localization team.
    2. Optional: If needed, modify the Manager field.
    3. If you are localizing the released content for the first time, from the Include field, select All Resources.
    4. If you have already localized the released content, from the Include field, select Only Changed Resources.
    5. In the Pick Target Locales field, add target languages.
  5. For XTM packages, do the following:
    1. Fill in the Project Name field.
    2. In the Pick Target Locales field, add target languages.
    3. If you are localizing the released content for the first time, from the Include field, select All Resources.
    4. If you have already localized the released content, from the Include field, select Only Changed Resources.
    5. From the Customer drop-down menu, select a relevant option.
    6. From the Template drop-down menu, select a relevant option.
  6. Click Save.
  7. For XLIFF, Media, and Source packages only:
    1. Click Download Localization Package to save the ZIP to your computer.
    2. Send the downloaded file to your localization provider.
    3. Once the localization is complete, upload the ZIP file with localized content back to Heretto CCMS.

Branch a Release

You can branch released content to edit it.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Hover over a release and click Branch.
  3. Click Create Branch.
  4. Fill in the New branch name field.
  5. Optional: If you do not want to switch to the new branch when it is created, clear the Navigate to new branch check box.
  6. Click Create.

Merge a Release into a Branch

You can merge released content into a new or an existing branch.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Hover over a release and click Branch.
  3. Depending on what kind of branching operation you want to perform, select Create Branch or Push Changes.
    • If you want to push the release to a new branch, choose Create Branch.

    • If you want to push the release to an existing branch, choose Push Changes.

  4. If you chose to create a new branch, select a name for the branch by filling in the appropriate field and click Create.
    Note:

    You can navigate to the newly create branch by choosing the Navigate to new branch option in the Create Branch menu.

    create branch menu

    You created a new branch that will contain an editable copy of the files from the release.

  5. If you chose to push the release to an existing branch, select Merge... and continue with 3 in Merge Branches.

Overwrite a Branch with a Release

You can overwrite a branch with released content.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Hover over a release and click Branch.
  3. Click Push Changes, select Replace and continue with 3 in Overwrite Branches.

Download a Release

You can download the source files of the released content.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Hover over a release and click Download.
    Release Options

Publish a Release

You can publish released content.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Hover over a release and click Output.
    Release options
  3. In the top-right corner, click the Publish button.
  4. From the list on the left, select a publishing scenario.
  5. Optional: In the Enter Description field, enter a meaningful description.
    Once you publish the document, this description appears in the list of finished publishing jobs.
  6. Set the publishing parameters.
    For detailed information on how to publish content with different publishing engines, see View a Release.
  7. Click Publish.
    The resource publishes. It may take a moment to complete.

View a Release

You can preview the archived versions of your content by viewing a release.

  1. In the content library, click a topic or a map and from the right pane, select Releases.
  2. Hover over a release and click View.
    Release options
  3. In the top right corner, click the Open file in editor button.

    Releases are non-editable snapshots of your content. To edit a release, branch it first. See, Branch a Release.