Versions Compared

Old Version 53

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version 54

changes.mady.by.user Toine Siebelink

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Deliver Release Artifacts

...

  • Ensure all commits are using related TOPIC (one topic for one artifact)
  • Add "Release Process Step #' to each commit message (first line) 



StepActionResultsExamples
1Update release notesRelease notes available on https://docs.onap.org/projects/onap-cps/en/latest/release-notes.htmlChange 123658
2

Update read-the-docs copies of openapi documentation e.g. for CPS-Core:

Code Block
titlecopy openapi.yaml
/cps-rest/target/generated-sources/swagger/openapi.yaml → /docs/api/swagger/cps/openapi.yaml
/cps-ncmp-rest/target/generated-sources/swagger/openapi.yaml → /docs/api/swagger/ncmp/openapi.yaml

For DMI-Plugin:

Code Block
titlecopy openapi.yaml
ncmp-dmi-plugin/src/target/generated-sources/swagger/openapi.yaml → /docs/openapi/openapi.yaml

Note 1. Run mvn clean install locally first to get required files in target subfolders

Note 2. This step can be skipped if there are no OPEN API changes

Latest (amalgamated) openapi.yaml available in read-the-docs
3Go to latest Gerrit merged review of repo and comment 'stage-release'
  • maven-stage Jenkins job is triggered
  • maven-docker-stage Jenkins job is triggered
  • Maven artifacts are published to Nexus 2 autorelease repository
  • Docker images are published to Nexus 3 registry
  • Change 118168
  • Job maven-stage-master 109
  • Job maven-docker-stage-master 109


4

Add and merge 'x.y.z.yaml' file to releases folder of the repository root.

It describes the release and refers to maven-stage job previously ran.

Note: This step is ignored for CPS Temporal (no Maven artifact delivered)

Note. this file should NOT contain 'tag_release=false'

Maven artifacts are published to maven release repository
  • Change 118174
  • Job cps-release-merge 1
5

Add and merge 'x.y.z-container.yaml' file to releases folder of the repository root.

It describes the release and refers to maven-docker-stage job previously ran.

Set "ref" to the (full) SHA of the last git

commit to be tagged.

commit (the commit from step 4 in less that step was skipped then it is the commit from step 3)


Take the latest built image, retag it without the timestamp :

e.g. SO release file

Code Block
container_release_tag: '1.1.0'
...
...
containers:
    - name: 'cps-and-ncmp'
      version: '1.1.0-SNAPSHOT-20210609T102555Z'


Docker image is published to docker release repository
  • Change 118178
  • Job cps-release-merge 2
6

Prepare the next release by bumping and merging new version numbers:

  • In pom files, set to x.y.z-SNAPSHOT by running "mvn versions:set -DnewVersion=<snapshot version>"
  • In version.properties, set to x.y.z


7

Update https://gerrit.onap.org/r/q/project:oom with the release specific changes: 

  • Update /kubernetes/cps/values.yaml with new image versions
  • Update /kubernetes/cps/resources/config/application.yml if properties need to be added or updated.

Before pushing changes to the release-specific OOM branch, it is required to push them to master first. If it can not be done, then specify a reason in the release-specific change (for example, image version number is branch specific and it is expected that it could be different in master branch and release branch).




Manage Release Branch

Prerequisites

...

  1. Decide with team if a bug should be dropped back to previous release or not, consider things like (use fix-version field in Jira to indicate this)
    1. bug was reported by user of previous release (easy decision (smile))
    2. bug exposes behavior that was not in line with acceptance criteria for a user story that was delivered in previous release
  2. Make the fix and have it merged in master branch
    1. use minimal code to avoid merge/drop back issues
    2. specific test for bug fix should be included where possible
  3. Cherry pick the fix from master branch to release branch
    1. From Gerrit:
      1. Navigate to ... / Cherry Pick
      2. Fill the form with the release branch name (honolulu) in "Cherry Pick to branch" field and click "Cherry Pick"


    2. Using local branch (to resolve cherry-pick conflicts):
      1. Create local branch from honolulu  (create branch & switch to branch)
      2. Cherry-pick commit from master branch
      3. Resolve conflicts
      4. Continue cherry-pick (git cherry-pick --continue)
      5. git push origin HEAD:refs/for/honolulu (or git review)
  4. Review patch by peers as normal
    1. Ensure that Gerrit merge requests both in master and release branches have the same Change-Id value (ex: https://gerrit.onap.org/r/q/Ia58a8dfcf427e373b24bb3be7436abf6abd55492). Then, related fixes can be easily filtered and clicking on the Change-Id from one change provides the list of all related ones.
  5. Update Release version in a separate commit if and when required
    A few bugs can be combined in one patch.
    Release notes doc should be updated too
    Typically only the 'patch' number (last digit) should be increased. See also
    1. Release Versioning Strategy (proposal for Honolulu)
    2. ONAP API Common Versioning Strategy (CVS) Guidelines
  6. Once the fix is in release branch, deliver releases artifacts from release branch as described in previous section.

...