github.com/apprenda/kismatic@v1.12.0/docs/development/RELEASE.md (about)

     1  # Release
     2  
     3  This document contains the release details for [Kismatic Enterprise Toolkit](https://github.com/apprenda/kismatic).
     4  
     5  Kismatic leverages a CI/CD pipeline to build, test and release its software. The pipeline extensively tests the software before any release is published and a build must pass all unit and integration tests to be promoted by the pipeline.
     6  
     7  Kismatic depends on [Kuberang](https://github.com/apprenda/kuberang) and the [Kismatic Distro Packages](https://github.com/apprenda/kismatic-distro-packages), along with all other components listed in the [README](https://github.com/apprenda/kismatic).
     8  All components are developed and versioned independently, however a released version of the Kismatic Enterprise Toolkit will have specified versions of the underlying components that have been previously tested for compatibility.   
     9  
    10  ### Releasing
    11  Once the master branch is ready for a release, it must be tagged and the tag pushed
    12  to the remote repository.
    13  ```
    14  git tag v1.1.0
    15  git push origin v1.1.0
    16  ```
    17  
    18  Pushing the tag will trigger a new build on the CI/CD system, which will have the
    19  release job enabled. Once all tests are finished, the release job will publish a draft
    20  release on GitHub and upload the binaries.
    21  
    22  Once the build is complete, go to `https://github.com/apprenda/kismatic/releases`
    23  to edit the release draft. 
    24  * Include a section that highlights any actions required by the user, if any.
    25  * Include a section that lists any deprecations that are being made in the release, if any.
    26  * Include a section that lists the notable changes. Each entry in the list should 
    27  include a link to the corresponding PR.
    28  * Include a section that lists any plan file changes.
    29  * Include a section that lists any component versions that have been changed in this new release
    30  * Include any other information that is relevant to the release
    31  
    32  ### Useful Git commands
    33  Get latest tag name:
    34  ```
    35  git describe --abbrev=0 --tags
    36  ```
    37  
    38  Get commit hash for a given tag
    39  ```
    40  git rev-list -n 1 $TAG
    41  ```