Versions Compared

Key

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

...

StepScopeActionResultsExamples
1Any Release






Update release notes
Note. Check documentation configuration and release instructions on: Create documentation for an ONAP release (ONAP project teams) 
Release notes available on https://docs.onap.org/projects/onap-cps/en/latest/release-notes.html

Change 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
cps-ncmp-rest/target/generated-sources/swagger/openapi-inventory.yaml → docs/api/swagger/ncmp/openapi-inventory.yaml 

For DMI-Plugin:

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

For CPS Temporal (no need to run mvn build for this one):

Code Block
titlecopy openapi.yml
openapi/swagger/openapi.yml → docs/_static/openapi/swagger/openapi.yml

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
3

For DMI Plugin and CPS Temporal, update any CPS Core release dependency, if needed:

  • ncmp-dmi-plugin/pom.xml (cps.version property)
  • cps-temporal/pom.xml (cps.version property)
  • cps-temporal/csit/plans/default/setup.sh (STABLE_CPS_CORE_VERSION environment variable to use for integration testing)

Changes


4Go 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 124884
  • Job maven-stage-master 145
  • Job maven-docker-stage-master 145


5

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
6

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 or the commit of the stage release
Note opinions difference what commit it should be exactly , fact is the ref. value is for  '(future) reference only' The process will complete either way and which commit exactly is bring referred too is quiet moot (not important)

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
7

Prepare the next drop by bumping patch version (3rd digit)

In
  1. Update all pom files
,
  1. ; set to x.y.z-SNAPSHOT by running "mvn versions:set -DnewVersion=<snapshot version>"
  2. In \version.properties, set to x.y.z
  3. Add section in \docs\release-notes.rst for next release

8

Update https://gerrit.onap.org/r/q/project:oom with the release specific changes: 
Note. Use [CPS] prefix for OOM commit message

  • 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).


9Only when BranchingCreate the (previous) release branch in Gerrit for the version you are releasing e.g. 'istanbul'. 
Has to be done manually (e.g. here: https://gerrit.onap.org/r/admin/repos/cps,branches)  by users with committer rights. 

https://gerrit.onap.org/r/admin/repos/cps,branches
10In ci-management repo, configure new Jenkins jobs for the release branch by adding a new release stream to the project. e.g. https://gerrit.onap.org/r/c/ci-management/+/118868/1/jjb/cps/cps.yaml
11

On Master branch increase Minor version of Master branch (2nd digit)

  • 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

12

On (previous) release (e.g. istanbul) branch:

  •  update ".gitreview" (change "defaultbranch" value)

...