Skip to content

how-to-release.md

Latest commit

 

History

History
41 lines (28 loc) · 1.56 KB

how-to-release.md

File metadata and controls

41 lines (28 loc) · 1.56 KB

Release Documentation

See the list of existing releases on GitHub.

A release of devops-docker-images is defined by a git tag and cohesive image tags on Docker Hub. Release version numbers are defined as matching the expression /^v(\d+)$/, so v17 is a valid example, and v17.3 is invalid.

Additional namespaced git tags for individual images (like cmclient-1.0.0.0) may exist and are not considered a release of the overall project. Namespaced tags may also contain postfix to document which tool version is packaged, like jenkinsfile-runner-v{n}-1.0-beta-7.

Testing

How to perform a release

  • Go to the releases page on GitHub
  • Select an appropriate tag name like v17 (by default increase the last release to the next major version)
    • GitHub will create the tag
  • Fill out release notes (see template below) informing the user about actions they need to take when using this release or new features
  • Publish the release
  • Observe the release builds on DockerHub
    • Check that all expected builds are triggered, and the builds succeed. This will take some time.

Release notes template

# Release `vX`

## New Functionality
*

## Improvements
*

## Fixes
*

## Incompatible Changes
*