Releases

Releases enable you to create 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 how the output looks like.
  • Establish a releases naming convention. Once you create a release, you cannot change its title.
  • 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, right-click a topic or a map and select Releases.
  2. Click Create Release.
  3. In the Create Release dialog, do the following:
    1. Fill in the Release name field.
    2. Optional: Fill in the Notes field.
    3. Click Create.

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 can be restored at any time.
  1. In the content library, right-click a topic or a map and select Releases.
  2. To deprecate a release, hover over a release that you want to deprecate and click Deprecate.
    Deprecated releases are listed below the active releases.
  3. To reactivate a deprecated release, hover over a deprecated release and click Undeprecate.

Branch a Release

You can branch released content to edit it.

  1. In the content library, right-click a topic or a map and 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 branch.

  1. In the content library, right-click a topic or a map and select Releases.
  2. Hover over a release and click Branch.
  3. Click Push Changes, 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, right-click a topic or a map and 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, right-click a topic or a map and select Releases.
  2. Hover over a release and click Download.

Publish a Release

You can publish released content.

  1. In the content library, right-click a topic or a map and select Releases.
  2. Hover over a release and click Output.
  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, right-click a topic or a map and select Releases.
  2. Hover over a release and click View.