From d7e7b1d0739989a36d23de3e2605cba1404f38c2 Mon Sep 17 00:00:00 2001 From: Nathaniel Ruiz Nowell Date: Fri, 13 Nov 2020 17:49:33 -0800 Subject: [PATCH 1/2] Workflow for PRs that would affect Contrib --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39d720d2dbc..949453f5378 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,6 +100,21 @@ $ git push fork feature Open a pull request against the main `opentelemetry-python` repo. +Pull requests are also tested for their compatibility with packages distributed +by OpenTelemetry in the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git). + +If a pull request introduces a change that would break the compatibility of +these packages with the Core packages in this repo, a separate PR should be +opened in the Contrib repo with changes to make the packages compatible. + +Once the pull request in the Contrib repo is open, take note of the commit SHA +and edit the `CONTRIB_SHA` variable found in `.github/workflows/test.yml` to +pass even the Contrib repo tests and so get the Core repo PR green and ready to +merge. + +**NOTE:** That Contrib pull request will also have to reference the commit SHA +of this Core pull request to pass its own tests. + ### How to Receive Comments * If the PR is not ready for review, please put `[WIP]` in the title, tag it @@ -113,6 +128,8 @@ A PR is considered to be **ready to merge** when: / [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer) (at different companies). * Major feedbacks are resolved. +* All tests are passing, including Contrib Repo tests which may require +updating the GitHub workflow to reference a PR in the Contrib repo * It has been open for review for at least one working day. This gives people reasonable time to review. * Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day. From 6b484137a2dd009d9657da7e6efeef2076df91d8 Mon Sep 17 00:00:00 2001 From: Nathaniel Ruiz Nowell Date: Tue, 17 Nov 2020 09:17:31 -0800 Subject: [PATCH 2/2] Detail guidelines for changing repo SHAs --- CONTRIBUTING.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 949453f5378..1cc74de3955 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,17 +103,20 @@ Open a pull request against the main `opentelemetry-python` repo. Pull requests are also tested for their compatibility with packages distributed by OpenTelemetry in the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git). -If a pull request introduces a change that would break the compatibility of +If a pull request (PR) introduces a change that would break the compatibility of these packages with the Core packages in this repo, a separate PR should be opened in the Contrib repo with changes to make the packages compatible. -Once the pull request in the Contrib repo is open, take note of the commit SHA -and edit the `CONTRIB_SHA` variable found in `.github/workflows/test.yml` to -pass even the Contrib repo tests and so get the Core repo PR green and ready to -merge. - -**NOTE:** That Contrib pull request will also have to reference the commit SHA -of this Core pull request to pass its own tests. +Follow these steps: +1. Open Core repo PR (Contrib Tests will fail) +2. Open Contrib repo PR and modify its `CORE_REPO_SHA` in `.github/workflows/test.yml` +to equal the commit SHA of the Core repo PR to pass tests +3. Modify the Core repo PR `CONTRIB_REPO_SHA` in `.github/workflows/test.yml` to +equal the commit SHA of the Contrib repo PR to pass Contrib repo tests (a sanity +check for the Maintainers & Approvers) +4. Merge the Contrib repo +5. Restore the Core repo PR `CONTRIB_REPO_SHA` to point to `master` +6. Merge the Core repo PR ### How to Receive Comments