Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release process wiki #4326

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Conversation

gaiksaya
Copy link
Member

@gaiksaya gaiksaya commented Jan 5, 2024

Description

This PR adds another page on GitHub wiki explaining release process for the distribution.
Also updates the URLs in the issue creation template to the wiki

Issues Resolved

#4216

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Sayali Gaikawad <[email protected]>
Copy link

codecov bot commented Jan 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7962e40) 91.27% compared to head (492c23a) 91.27%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4326   +/-   ##
=======================================
  Coverage   91.27%   91.27%           
=======================================
  Files         189      189           
  Lines        6163     6163           
=======================================
  Hits         5625     5625           
  Misses        538      538           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be updated to Releasing-the-Distribution?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -1,83 +1,7 @@
- [OpenSearch Release Process](#opensearch-release-process)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we still keep these heading mappings without removing them? So that if we have pull back from docs/ folder we still have the headings in markdown format.

Copy link
Member Author

@gaiksaya gaiksaya Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is taking up a lot of space (almost 1.5 page) Also if we need to revert back, just reverting this PR should restore it. The wiki auto formats the table of contents so no need to maintain our own version.

image

@gaiksaya gaiksaya merged commit 068d863 into opensearch-project:main Jan 12, 2024
13 of 14 checks passed
@gaiksaya gaiksaya deleted the add-release-wiki branch January 12, 2024 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants