Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 5.12 KB

release_template.md

File metadata and controls

91 lines (65 loc) · 5.12 KB
Raw
name title labels
Release
[RELEASE] Release version {{ env.VERSION }}
untriaged, release, v{{ env.VERSION }}

Release OpenSearch and OpenSearch Dashboards {{ env.VERSION }}

I noticed that a manifest was automatically created in [manifests/{{ env.VERSION }}](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}). Please follow the following checklist to make a release.

How to use this issue

This Release Issue

This issue captures the state of the OpenSearch release, its assignee is responsible for driving the release. Please contact them or @mention them on this issue for help. There are linked issues on components of the release where individual components can be tracked.

Release Steps

There are several steps to the release process, these steps are completed as the whole release and components that are behind present risk to the release. The release owner completes the tasks in this ticket, whereas component owners resolve tasks on their ticket in their repositories.

Steps have completion dates for coordinating efforts between the components of a release; components can start as soon as they are ready far in advance of a future release.

Component List

To aid in understanding the state of the release there is a table with status indicating each component state. This is updated based on the status of the component issues.

Preparation

  • Assign this issue to a release owner.
  • Declare a pencils down date for new features to be merged. RELEASE-minus-14-days is pencils down
  • Update the Campaigns section to include monitoring campaigns during this release.
  • Update this issue so all RELEASE- placeholders have actual dates.
  • Document any new quality requirements or changes.
  • Declare a pencils down date for new features to be merged.
  • Finalize scope and feature set and update the Public Roadmap.
  • Create a version label in each component repo.
  • Create a release issue in every component repo that links back to this issue, update Components section with these links.
  • Ensure that all release issues created above are assigned to an owner in the component team.

CI/CD - Ends RELEASE-minus-14-days

  • Create Jenkins workflows that run daily snapshot builds for OpenSearch and OpenSearch Dashboards.
  • Increment each component version to {{ env.VERSION }} and ensure working CI in component repositories.
  • Make pull requests to add each component to [manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml) and [manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml) with the corresponding checks.

Campaigns

Replace with OpenSearch wide initiatives to improve quality and consistency.

Release testing - Ends RELEASE-minus-6-days

  • Code Complete (RELEASE-minus-14-days - RELEASE-minus-11-days): Teams test their component within the distribution, ensuring integration, backwards compatibility, and perf tests pass.
  • Sanity Testing (RELEASE-minus-8-days - RELEASE-minus-6-days): Sanity testing and fixing of critical issues found by teams.

Release - Ends {RELEASE-day}

  • Declare a release candidate build, and publish all test results.
  • Verify all issued labeled v{{ env.VERSION }} in all projects have been resolved.
  • Complete documentation for this release.
  • Author blog post for this release.
  • Gather, review and publish release notes.
  • RELEASE-minus-1-day - Publish this release on opensearch.org.
  • RELEASE-day - Publish blog post - release is launched!

Post Release

  • Create release tags for each component.
  • Replace refs in [manifests/{{ env.VERSION }}](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}) with tags.
  • Update this template with any new or missed steps.
  • Conduct a postmortem, and publish its results.

Components

Replace with links to all component tracking issues.

Component On track Notes
{COMPONENT_ISSUE_LINK} {INDICATOR}} {STATUS}
Legend

Symbol Meaning
🟢 On track with overall release
🟡 Missed last milestone
🔴 Missed multiple milestones