Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
zelinh committed Aug 19, 2024
2 parents 5be4979 + 91327a0 commit af12b5c
Show file tree
Hide file tree
Showing 19 changed files with 3,857 additions and 373 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/release_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Please refer to the following link for the release version dates: [Release Sched
### [Entrance Criteria](https://github.com/opensearch-project/.github/blob/main/RELEASING.md#entrance-criteria-to-start-release-window)
Criteria | Status | Description  | Comments
-- | -- | -- | --
Each component release issue has an assigned owner | :red_circle: | |
Documentation draft PRs are up and in tech review for all component changes | :red_circle: | |
Sanity testing is done for all components | :red_circle: | |
Code coverage has not decreased (all new code has tests) | :red_circle: | |
Expand Down Expand Up @@ -87,7 +88,7 @@ Release blog is ready | :red_circle: | |
- [ ] [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).

- [ ] [Stop Release Candidate periodic auto builds](https://github.com/opensearch-project/opensearch-build/wiki/Releasing-the-Distribution#stop-periodic-auto-builds)
### [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
Expand Down Expand Up @@ -147,7 +148,6 @@ Release blog is ready | :red_circle: | |
### Post-Release activities
- [ ] Release Tags.
- [ ] Input Manifest Update.
- [ ] Decrease the Build Frequency.
- [ ] OpenSearch Build Release notes.
- [ ] Retrospective Issue.
- [ ] Helm and Ansible Playbook release.
Expand Down
69 changes: 69 additions & 0 deletions TRIAGING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">

The maintainers of the OpenSearch-build Repo seek to promote an inclusive and engaged community of contributors. In order to facilitate this, bi-weekly triage meetings are open-to-all and attendance is encouraged for anyone who hopes to contribute, discuss an issue, or learn more about the project. To learn more about contributing to the OpenSearch-build Repo visit the [Contributing](./CONTRIBUTING.md) documentation.

### Do I need to attend the meeting for my issue to be addressed/triaged?

Attendance is not required for your issue to be triaged or addressed. All new issues are triaged bi-weekly.

### What happens if my issue does not get covered this time?

Each meeting we seek to address all new issues. However, should we run out of time before your issue is discussed, you are always welcome to attend the next meeting or to follow up on the issue post itself.

### How do I join the Backlog & Triage meeting?

Meetings are hosted regularly at 9 AM Pacific Time and can be joined via the links posted on the [OpenSearch Meetup Group](https://www.meetup.com/opensearch/events/) list of events. The event will be titled `Engineering Effectiveness Triage Meeting`.

After joining the Zoom meeting, you can enable your video / voice to join the discussion. If you do not have a webcam or microphone available, you can still join in via the text chat.

If you have an issue you'd like to bring forth please consider getting a link to the issue so it can be presented to everyone in the meeting.

### Is there an agenda for each week?

Meetings are 45 minutes and structured as follows:

1. Initial Gathering: As we gather, feel free to turn on video and engage in informal and open-to-all conversation. After a bit a volunteer will share their screen and proceed with the agenda.
2. Announcements: If there are any announcements to be made they will happen at the start of the meeting.
3. Review of New Issues: The meetings always start with reviewing all untriaged [issues](https://github.com/orgs/opensearch-project/projects/208/views/2) for below repositories:
1. [opensearch-build](https://github.com/opensearch-project/opensearch-build)
1. [opensearch-ci](https://github.com/opensearch-project/opensearch-ci)
1. [opensearch-build-libraries](https://github.com/opensearch-project/opensearch-build-libraries)
1. [helm-charts](https://github.com/opensearch-project/helm-charts)
1. [terraform-provider-opensearch](https://github.com/opensearch-project/terraform-provider-opensearch)
1. [ansible-playbook](https://github.com/opensearch-project/ansible-playbook)
1. [opensearch-cluster-cdk](https://github.com/opensearch-project/opensearch-cluster-cdk)
1. [opensearch-devops](https://github.com/opensearch-project/opensearch-devops)
4. Member Requests: Opportunity for any meeting member to ask for consideration of an issue or pull request.
5. Untriaged Items: Review any [issues](https://github.com/orgs/opensearch-project/projects/208/views/2) that might have had the 'untriaged' label removed but require additional triage discussion.
6. Open Discussion: Allow for members of the meeting to surface any topics without issues filed or pull request created.


There is no specific ordering within each category.

If you have an issue you would like to discuss but do not have the ability to attend the entire meeting, please attend when is best for you and signal that you have an issue to discuss when you arrive.

### Is prior contribution to the project required to attend a triage meeting?

No, all are welcome and encouraged to attend. Attending the Backlog & Triage meetings is a great way for a new contributor to learn about the project as well as explore different avenues of contribution.

### What if I have an issue that is almost a duplicate, should I open a new one to be triaged?

You can always open an [issue](https://github.com/opensearch-project/opensearch-build/issues/new/choose) including one that you think may be a duplicate. However, in cases where you believe there is an important distinction to be made between an existing issue and your newly created one, you are encouraged to attend the triaging meeting to explain.

### What if I have follow-up questions on an issue?

If you have an existing issue you would like to discuss, you can always comment on the issue itself. Alternatively, you are welcome to come to the triage meeting to discuss.

### What are the issue labels associated with triaging?

Yes, there are several labels that are used to identify the 'state' of issues filed.

| Label | When applied | Meaning |
| ----- | ------------ | ------- |
| Untriaged | When issues are created or re-opened. | Issues labeled as 'Untriaged' require the attention of the repository maintainers and may need to be prioritized for quicker resolution. |
| Help Wanted | Anytime. | Issues marked as 'Help Wanted' signal that they are actionable and not the current focus of the project maintainers. Community contributions are especially encouraged for these issues. |
| Good First Issue | Anytime. | Issues labeled as 'Good First Issue' are small in scope and can be resolved with a single pull request. These are recommended starting points for newcomers looking to make their first contributions. |

### Who should I contact if I have further questions?

You can always file an [issue](https://github.com/opensearch-project/opensearch-build/issues/new/choose) for any question you have about the project. Alternatively, you can use [opensearch slack](https://opensearch.org/slack.html) channels such as #infra #devops for any related queries.
7 changes: 2 additions & 5 deletions docs/Releasing-the-Distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ This section is not required for a patch release.

### Component Release Issues

The component release issues are auto created by the workflows part of the build repo [OpenSearch components](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/os-release-issues.yml), [OpenSearch Dashboards components](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/osd-release-issues.yml). These workflows create the release issues based on the template [component_release_template.md](https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/component_release_template.md) and links back the global release issue part of the build. Sample component release issues created for 2.10.0. Sample link `https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Aopensearch-project+%5BRELEASE%5D+Release+version+2.10.0+in%3Atitle+`.
The component release issues are auto created by the workflows part of the build repo [OpenSearch components](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/os-release-issues.yml), [OpenSearch Dashboards components](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/osd-release-issues.yml). These workflows create the release issues based on the template [component_release_template.md](https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/component_release_template.md) and links back the global release issue part of the build. Sample [component release issue](https://github.com/opensearch-project/job-scheduler/issues/642) created for 2.16.0 release. The release manager must verify that each component release issue has an assigned owner, as this is one of the entry criteria for the release.

#### Issue Creation Process Overview

Expand Down Expand Up @@ -294,6 +294,7 @@ All the failed logs are in s3 accessed through the cloudfront. Sample [link](htt

Stop builds for this version of OpenSearch and/or OpenSearch Dashboards in order to avoid accidental commits going in unknowingly. Restart only if necessary, else manually run the build workflow and declare new release candidate.

#### Stop Periodic Auto Builds
Once the RC is finalized, in order to exclude the release from running periodically, at this point it is necessary for the release manager to lock the input manifest and update the `check-for-build.jenkins` to remove it from the scheduled execution, sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3523/files).


Expand Down Expand Up @@ -384,10 +385,6 @@ Replace `refs` in input manifest with tags. The `refs` can be identified from th

Generate distribution release notes for opensearch-build repository, sample [1.3.10](https://github.com/opensearch-project/opensearch-build/releases/tag/1.3.10) release details.

### Decrease the build frequency

Lower the frequency of builds for the release version of OpenSearch and/or OpenSearch Dashboards, sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3523).

### Retrospective Issue

Create an issue for a retrospective, solicit feedback, and publish a summary. Sample [retro issue](https://github.com/opensearch-project/opensearch-build/issues/3535).
Expand Down
Loading

0 comments on commit af12b5c

Please sign in to comment.