Skip to content



Shared library with helper functions to manage OpenAPI YAML related changes. Currently used by sdk repos.

Required Yaml

Name Required Type Description and Default Value
apiInfo.nextReleaseVersion true str Next release version to for the OpenAPI yaml files.
apiInfo.reviewers true str Who to assign the generated PR to.


  • edgeXReleaseOpenApi.publishReleaseBranch: Makes release branch related changes in unique branch then commits release branch.
  • edgeXReleaseOpenApi.publishOpenApiChanges: Makes OpenAPI related changes in unique branch then commits and opens PR.
  • edgeXReleaseOpenApi.validate: Validates release yaml input before any automation is run.


Sample Release Yaml

name: 'device-sdk-go'
version: '2.2.0'
releaseName: 'kamakura'
releaseStream: 'main'
repo: ''
commitId: 'c72b16708d6eed9a08be464a432ce22db7d90667'
gitTag: true
dockerImages: false
gitHubRelease: false
apiInfo: [
   nextReleaseVersion: '2.3.0',
   reviewers: edgexfoundry/edgex-committers

Groovy Call