diff --git a/.github/ISSUE_TEMPLATE/release_template.md b/.github/ISSUE_TEMPLATE/release_template.md index 30f325e70b..4fbf1350ef 100644 --- a/.github/ISSUE_TEMPLATE/release_template.md +++ b/.github/ISSUE_TEMPLATE/release_template.md @@ -13,7 +13,7 @@ I noticed that a manifest was automatically created in [manifests/{{ env.VERSION ## This Release Issue -This issue captures the state of the OpenSearch release, its assignee (Release Manager) 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. For more information check the the [Release Process OpenSearch Guide](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md). +This issue captures the state of the OpenSearch release, its assignee (Release Manager) 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. For more information check the the [Release Process OpenSearch Guide](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution).

@@ -48,66 +48,66 @@ No unpatched vulnerabilities of medium or higher severity that have been publicl All integration tests are passing | :red_circle: | | Release blog is ready | :red_circle: | | -### [Preparation](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#preparation) +### [Preparation](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#preparation) -- [ ] [Release manager](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-manager) assigned. -- [ ] Existence of label in each component repo. For more information check the [release-label](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-label) section. -- [ ] [Increase the build frequency](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#increase-the-build-frequency). -- [ ] [Release Issue](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-issue). +- [ ] [Release manager](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-manager) assigned. +- [ ] Existence of label in each component repo. For more information check the [release-label](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-label) section. +- [ ] [Increase the build frequency](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#increase-the-build-frequency). +- [ ] [Release Issue](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-issue). -### [Campaigns](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#campaigns) +### [Campaigns](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#campaigns) -- [ ] [Component Release Issue](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#component-release-issue). -- [ ] [Release Campaigns](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-campaigns). +- [ ] [Component Release Issue](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#component-release-issue). +- [ ] [Release Campaigns](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-campaigns). -### [Release Branch and Version Increment](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-branch-readiness) - _Ends __REPLACE_RELEASE-minus-4-days__ +### [Release Branch and Version Increment](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-branch-readiness) - _Ends __REPLACE_RELEASE-minus-4-days__ -- [ ] [Core Release Branch](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#core). -- [ ] [Core Version Increment](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#core-version-increment). -- [ ] [Components Release Branch](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#components). -- [ ] [Components Version Increment](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#components-version-increment). +- [ ] [Core Release Branch](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#core). +- [ ] [Core Version Increment](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#core-version-increment). +- [ ] [Components Release Branch](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#components). +- [ ] [Components Version Increment](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#components-version-increment). -### [Feature Freeze](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#code-complete-and-feature-freeze) - _Ends __REPLACE_RELEASE-minus-12-days__ +### [Feature Freeze](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#code-complete-and-feature-freeze) - _Ends __REPLACE_RELEASE-minus-12-days__ - [ ] OpenSearch / OpenSearch-Dashboards core and components teams finalize their features. -### [Code Complete](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#code-complete-and-feature-freeze) - _Ends __REPLACE_RELEASE-minus-10-days___ +### [Code Complete](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#code-complete-and-feature-freeze) - _Ends __REPLACE_RELEASE-minus-10-days___ -- [ ] Mark this as done once the [Code Complete](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#code-complete-and-feature-freeze) is reviewed. +- [ ] Mark this as done once the [Code Complete](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#code-complete-and-feature-freeze) is reviewed. - [ ] Create/Verify pull requests to add each component to relase input [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). -### [Release Candidate Creation and Testing](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-candidate-creation-and-testing) - _Ends __REPLACE_RELEASE-minus-6-days___ +### [Release Candidate Creation and Testing](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-candidate-creation-and-testing) - _Ends __REPLACE_RELEASE-minus-6-days___ -- [ ] [Generate Release Candidate](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-candidate). -- [ ] [Integ Test TAR](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#integ-test-tar). -- [ ] [Integ Test RPM](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#integ-test-rpm). -- [ ] [Docker Build and Scan](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#docker-build-and-scan). -- [ ] [Backwards Compatibility Tests](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#backwards-compatibility-tests). -- [ ] [Windows Integration Test](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#windows-integration-test). -- [ ] [Broadcast and Communication](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#broadcast-and-communication). -- [ ] [Release Candidate Lock](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-candidate-lock). +- [ ] [Generate Release Candidate](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-candidate). +- [ ] [Integ Test TAR](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#integ-test-tar). +- [ ] [Integ Test RPM](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#integ-test-rpm). +- [ ] [Docker Build and Scan](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#docker-build-and-scan). +- [ ] [Backwards Compatibility Tests](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#backwards-compatibility-tests). +- [ ] [Windows Integration Test](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#windows-integration-test). +- [ ] [Broadcast and Communication](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#broadcast-and-communication). +- [ ] [Release Candidate Lock](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-candidate-lock). -### [Performance testing validation](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#benchmark-tests) - _Ends __REPLACE_RELEASE-minus-6-days___ +### [Performance testing validation](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#benchmark-tests) - _Ends __REPLACE_RELEASE-minus-6-days___ - [ ] Post the benchmark-tests - [ ] Longevity tests do not show any issues. -### [Pre Release](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#pre-release) - _Ends __REPLACE_RELEASE-minus-1-days___ +### [Pre Release](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#pre-release) - _Ends __REPLACE_RELEASE-minus-1-days___ -- [ ] [Release Labeled Issues](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-labeled-issues). -- [ ] [Go or No-Go](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#go-or-no-go). -- [ ] [Promote Repos](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#promote-repos). -- [ ] [Promote artifacts](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#promote-artifacts). -- [ ] [Release Notes](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-notes). +- [ ] [Release Labeled Issues](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-labeled-issues). +- [ ] [Go or No-Go](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#go-or-no-go). +- [ ] [Promote Repos](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#promote-repos). +- [ ] [Promote artifacts](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#promote-artifacts). +- [ ] [Release Notes](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-notes). -### [Release](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#main-release) - _Ends {__REPLACE_RELEASE-day}_ +### [Release](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#main-release) - _Ends {__REPLACE_RELEASE-day}_ -- [ ] [Maven Promotion](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#maven-promotion). -- [ ] [Docker Promotion](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#docker-promotion). -- [ ] [Release Validation](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-validation). -- [ ] [Collaboration with the Project Management Team](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#collaboration-with-the-project-management-team). +- [ ] [Maven Promotion](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#maven-promotion). +- [ ] [Docker Promotion](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#docker-promotion). +- [ ] [Release Validation](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-validation). +- [ ] [Collaboration with the Project Management Team](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#collaboration-with-the-project-management-team). -### [Release Checklist](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-checklist). +### [Release Checklist](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-checklist).
Release Checklist @@ -156,15 +156,15 @@ Release blog is ready | :red_circle: | |

-### [Post Release](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#post-release) +### [Post Release](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#post-release) -- [ ] [Release Tags](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#release-tags). -- [ ] [Input Manifest Update](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#input-manifest-update). -- [ ] [OpenSearch Build Release notes](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#opensearch-build-release-notes). -- [ ] [Decrease the Build Frequency](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#decrease-the-build-frequency). -- [ ] [Retrospective Issue](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#retrospective-issue). -- [ ] [Helm and Ansible Playbook release](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#helm-and-ansible-playbook-release). -- [ ] [Upcoming Release Preparation](https://github.com/opensearch-project/opensearch-build/blob/main/RELEASE_PROCESS_OPENSEARCH.md#upcoming-release-preparation). +- [ ] [Release Tags](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#release-tags). +- [ ] [Input Manifest Update](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#input-manifest-update). +- [ ] [OpenSearch Build Release notes](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#opensearch-build-release-notes). +- [ ] [Decrease the Build Frequency](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#decrease-the-build-frequency). +- [ ] [Retrospective Issue](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#retrospective-issue). +- [ ] [Helm and Ansible Playbook release](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#helm-and-ansible-playbook-release). +- [ ] [Upcoming Release Preparation](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#upcoming-release-preparation). ### Components @@ -172,7 +172,7 @@ __Replace with links to all component tracking issues.__ | Component | On track | Release Notes | | --------- | -------- | ----- | -| {COMPONENT_ISSUE_LINK} | {INDICATOR}} | {STATUS} | +| {COMPONENT_ISSUE_LINK} | {INDICATOR} | {STATUS} |
Legend

diff --git a/docs/Home.md b/docs/Home.md index b8ad9ce3d6..645dbe0014 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -7,3 +7,4 @@ This repository hosts the build, test and release scripts for OpenSearch and Ope See each page below for more details: - [Building a Distribution from the source](https://github.com/opensearch-project/opensearch-build/wiki/Building-an-OpenSearch-and-OpenSearch-Dashboards-Distribution) - [Testing a Distribution](https://github.com/opensearch-project/opensearch-build/wiki/Testing-the-Distribution) +- [Releasing the Distribution](https://github.com/opensearch-project/opensearch-build/wiki/Testing-the-Distribution) \ No newline at end of file diff --git a/RELEASE_PROCESS_OPENSEARCH.md b/docs/Releasing-the-Distribution.md similarity index 90% rename from RELEASE_PROCESS_OPENSEARCH.md rename to docs/Releasing-the-Distribution.md index 9abf7bd5d0..0ce5df569e 100644 --- a/RELEASE_PROCESS_OPENSEARCH.md +++ b/docs/Releasing-the-Distribution.md @@ -1,83 +1,7 @@ -- [OpenSearch Release Process](#opensearch-release-process) - - **[Preparation](#preparation)** - - [Release Terminology and Knowledge Center](#release-terminology-and-knowledge-center) - - [Definitions](#definitions) - - [Types of Manifests](#types-of-manifests) - - [Input Manifest](#input-manifest) - - [Test Manifest](#test-manifest) - - [Build Manifest](#build-manifest) - - [Bundle Manifest](#bundle-manifest) - - [AUTOCUT issues](#autocut-issues) - - [Build Workflows](#build-workflows) - - [Release Workflows](#release-workflows) - - [Creating a New Version](#creating-a-new-version) - - [Release Manager](#release-manager) - - [Release label](#release-label) - - [Release Issue](#release-issue) - - [Release Issue Update](#release-issue-update) - - [Increase the Build Frequency](#increase-the-build-frequency) - - [Update the Maven Publish Workflow](#update-the-maven-publish-workflow) - - **[Campaigns](#campaigns)** - - [Component Release Issues](#component-release-issues) - - [Issue Creation Process Overview](#issue-creation-process-overview) - - [Release Campaigns](#release-campaigns) - - **[Release Branch Readiness](#release-branch-readiness)** - - [Release Branch](#release-branch) - - [Core](#core) - - [Components](#components) - - [Version Increment](#version-increment) - - [Core Version Increment](#core-version-increment) - - [Components Version Increment](#components-version-increment) - - **[Code Complete and Feature Freeze](#code-complete-and-feature-freeze)** - - **[Release Candidate Creation and Testing](#release-candidate-creation-and-testing)** - - [Distribution Build](#distribution-build) - - [Workflow Trigger](#workflow-trigger) - - [Order of Execution](#order-of-execution) - - [OpenSearch](#opensearch) - - [OpenSearch Dashboards](#opensearch-dashboards) - - [Release Candidate](#release-candidate) - - [Sample Build details](#sample-build-details) - - [Integ Test TAR](#integ-test-tar) - - [Integ Test RPM](#integ-test-rpm) - - [Docker Build and Scan](#docker-build-and-scan) - - [Docker RC Freeze](#docker-rc-freeze) - - [Benchmark Tests](#benchmark-tests) - - [Backwards Compatibility Tests](#backwards-compatibility-tests) - - [Windows Integration Test](#windows-integration-test) - - [Broadcast and Communication](#broadcast-and-communication) - - [Release Candidate Lock](#release-candidate-lock) - - **[Release](#release)** - - [Pre-Release](#pre-release) - - [Release Labeled Issues](#release-labeled-issues) - - [Go or No-Go](#go-or-no-go) - - [Promote Repos](#promote-repos) - - [Promote Artifacts](#promote-artifacts) - - [Release Notes](#release-notes) - - [Main Release](#main-release) - - [Maven Promotion](#maven-promotion) - - [Docker Promotion](#docker-promotion) - - [Collaboration with the Project Management Team](#collaboration-with-the-project-management-team) - - [Website and Documentation Changes](#website-and-documentation-changes) - - [Publish blog posts](#publish-blog-posts) - - [Advertise on Social Media](#advertise-on-social-media) - - [Release Validation](#release-validation) - - [Release Checklist](#release-checklist) - - **[Post Release](#post-release)** - - [Release Tags](#release-tags) - - [Input Manifest Update](#input-manifest-update) - - [OpenSearch Build Release notes](#opensearch-build-release-notes) - - [Decrease the build frequency](#decrease-the-build-frequency) - - [Retrospective Issue](#retrospective-issue) - - [Helm and Ansible Playbook release](#helm-and-ansible-playbook-release) - - [Upcoming Release Preparation](#upcoming-release-preparation) - - **[Communication Templates](#communication-templates)** - - [Release Announcement](#release-announcement) - - [Release Readiness](#release-readiness) - - [Release Candidate Announcement](#release-candidate-announcement) - - [Release Complete](#release-complete) - # OpenSearch Release Process +This document explains the OpenSearch Process in detail. + ## Preparation ### Release Terminology and Knowledge Center