Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 2.27 KB

RELEASING.md

File metadata and controls

45 lines (39 loc) · 2.27 KB

How to Create a Release of OpenTelemetry Configuration (for Maintainers Only)

  • Prepare the release by:
    • If preparing a minor or major release, merge a PR to main to update file_format.
    • Merge a PR to main to update the CHANGELOG.md. Changes should be listed under a heading of the form ## v{Major}.{Minor}.{Patch} - YYYY-MM-DD under ## Unreleased. Maintainers should highlight any breaking changes. You can use ./.github/scripts/draft-change-log-entries.sh <previous_version_tag> or the Github compare tool to view a summary of all commits since last release as a reference. From this point on no new PRs can be merged until the release is complete.
  • Go to Github release page, click Draft a new release.
  • Click "Choose a tag" and specify the next version number. The Target branch should be "main".
  • Click "Generate release notes" to get a draft release notes. Refer to CHANGELOG.md for a list of changes since last release.
  • Click "Publish Release".
  • Open a PR to update the schemastore entry to include the new tag. Update the url to be the latest, and versions to include the newly tag. For example ( TODO: update to an update PR after we have one to reference).

Our tags follow the naming convention of v<major>.<minor>.<patch>. Increment minor by 1 and use patch value of 0 for new minor version releases. For patch releases keep minor unchanged and increment the patch.

Update file_format {#update-file-format}

Update the file_format: "<major>.<minor> of ./examples and ./snippets as follows:

# Set FILE_FORMAT env var to target version of the release
export FILE_FORMAT=0.4
make update-file-format

Merge a PR with the changes to main.