Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.52 KB

RELEASE.md

File metadata and controls

49 lines (33 loc) · 1.52 KB

TaSecureApi Release Process

This document describes the process to release source code and specifications associated with the TaSecureApi project.

(1) Tag the repository

Tagging via GitHub

From within a local copy of the repository with HEAD at the desired commit to be tagged and released, use git to create an annotated tag and complete via a typical GitHub code review.

$ git tag -a <tag name> -m "<tag message>"
$ git push <remote> -tags

Tagging Directly

RDK Central GitHub repository owners have the ability to directly push annotated tags without going through a GitHub code review.

Naming Conventions

For consistency, release commits should be tagged using the following syntax:

`<ReleaseName>-<ReleaseVersion>`

where:

  • <ReleaseName> is the name of the code or specifications being tagged. Tag name shall be specified using UpperCamelCase syntax.
  • <ReleaseVersion> is the string representing the version being released. The set of characters allowed for the version string is restricted to alphanumeric characters and the period symbol. For example, 1.4.DO3.

Additional References

Informative git tagging tutorial is available here.

(2) Generating Release Documentation

Documents and specifications should be rendered into a common document viewing format such as HTML and PDF.

To generate release documentation:

  • cd to the 'docs' directory
  • Execute ./generate_docs.sh