Skip to content

Commit

Permalink
Refactor release issue template and release wiki based on new changes (
Browse files Browse the repository at this point in the history
…#5031)

Signed-off-by: Sayali Gaikawad <[email protected]>
  • Loading branch information
gaiksaya committed Sep 20, 2024
1 parent e3e26e1 commit 4aa74af
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 31 deletions.
14 changes: 1 addition & 13 deletions .github/ISSUE_TEMPLATE/release_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,11 @@ Release blog is ready | :red_circle: | |

- [ ] [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/wiki/Releasing-the-Distribution#main-release) - _Ends {__REPLACE_RELEASE-day}_

- [ ] [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).
- [ ] [Central Promotion Workflow](https://github.com/opensearch-project/opensearch-build/wiki/Central-Release-Promotion-Workflow).
- [ ] [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/wiki/Releasing-the-Distribution#release-checklist).
Expand Down Expand Up @@ -145,14 +141,6 @@ Release blog is ready | :red_circle: | |
- [ ] Advertise on Social Media.
- [ ] Post on public slack and Github Release issue.

### Post-Release activities
- [ ] Release Tags.
- [ ] Input Manifest Update.
- [ ] OpenSearch Build Release notes.
- [ ] Retrospective Issue.
- [ ] Helm and Ansible Playbook release.
- [ ] Upcoming Release Preparation.

</p>
</details>
<br>
Expand Down
37 changes: 19 additions & 18 deletions docs/Releasing-the-Distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,15 +311,29 @@ Verify all issues labeled with this release have been resolved. Coordinate with

Get the Go / No-Go votes from project management committee (PMC) before staging the release artifacts for production publishing process,

#### Promote Repos

#### Release Notes

Coordinate with the plugin teams and create a consolidates release notes. Sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3532). Release manager can check if a plugin team has created a release notes or not using the [release notes tracker tool](https://github.com/opensearch-project/opensearch-build/tree/main/src/release_notes_workflow). Sample [run](https://build.ci.opensearch.org/job/release-notes-tracker/).


### Main Release

Release the artifacts to production distribution channels, update the website and inform the community of the release.

#### Central Release Promotion Workflow

The [central release promotion workflow ](https://build.ci.opensearch.org/job/central-release-promotion/) consist of multiple child workflows such as:

* *Promote Repos* : Publishes DEBIAN and RPM repositories.

| Repo | OpenSearch (Sample Runs) | OpenSearch Dashboards (Sample Runs) |
| ---- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| YUM | [yum-os](https://build.ci.opensearch.org/job/distribution-promote-repos/46/) | [yum-osd](https://build.ci.opensearch.org/job/distribution-promote-repos/48/) |
| APT | [apt-os](https://build.ci.opensearch.org/job/distribution-promote-repos/) | [apt-osd](https://build.ci.opensearch.org/job/distribution-promote-repos/49/) |


#### Promote Artifacts
* *Promote Artifacts*: Promotes below artifacts:

| Artifacts | OpenSearch (Sample Runs) | OpenSearch Dashboards (Sample Runs) |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -328,21 +342,12 @@ Get the Go / No-Go votes from project management committee (PMC) before staging
| TAR | [os-tar-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/243/), [os-tar-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/246/) | [osd-tar-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/245/), [osd-tar-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/244/) |
| RPM | [os-rpm-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/239/), [os-rpm-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/240/) | [osd-rpm-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/241/), [osd-rpm-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/242/) |

* *Maven Promotion* : Promote OpenSearch to maven central, trigger the `publish-to-maven workflow` (Ref [Release Workflows](#release-workflows)), sample [run](https://build.ci.opensearch.org/job/publish-to-maven/17/console).

#### Release Notes

Coordinate with the plugin teams and create a consolidates release notes. Sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3532). Release manager can check if a plugin team has created a release notes or not using the [release notes tracker tool](https://github.com/opensearch-project/opensearch-build/tree/main/src/release_notes_workflow). Sample [run](https://build.ci.opensearch.org/job/release-notes-tracker/).
* *Docker Promotion* : Publish the images to docker and ECR, trigger the `docker promotion workflow` (Ref [Release Workflows](#release-workflows)), sample [run](https://build.ci.opensearch.org/job/docker-promotion/32/console).

* *Distribution Validation* : Use the validation workflow (Ref [Release Workflows](#release-workflows)) to validate the published artifacts, sample [validation workflow run](https://build.ci.opensearch.org/job/distribution-validation/3/console).

### Main Release

Release the artifacts to production distribution channels, update the website and inform the community of the release.

#### Maven Promotion
Promote OpenSearch to maven, trigger the `publish-to-maven workflow` (Ref [Release Workflows](#release-workflows)), sample [run](https://build.ci.opensearch.org/job/publish-to-maven/17/console).

#### Docker Promotion
Publish the images to docker and ECR, trigger the `docker promotion workflow` (Ref [Release Workflows](#release-workflows)), sample [run](https://build.ci.opensearch.org/job/docker-promotion/32/console).

#### Collaboration with the Project Management Team

Expand All @@ -360,10 +365,6 @@ Coordinate with the documentation website team to ensure the changes are in plac

Coordinate with the project management team to ensure the social media advertisement is completed.

#### Release Validation

Use the validation workflow (Ref [Release Workflows](#release-workflows)) to validate the published artifacts, sample [validation workflow run](https://build.ci.opensearch.org/job/distribution-validation/3/console).

### Release Checklist

Please update the checklist either in the release issue body or as a new comment to the release issue. By following and updating the release checklist, we can ensure the success of the release. Sample release checklist for [2.9.0 release](https://github.com/opensearch-project/opensearch-build/issues/3616#issuecomment-1646312725).
Expand Down

0 comments on commit 4aa74af

Please sign in to comment.