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.

Sign up for GitHub

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

Jump to bottom

Workflow for PRs that would affect Contrib #1382

Merged
merged 4 commits into from
Nov 18, 2020
Merged

Workflow for PRs that would affect Contrib #1382

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7e7b1d
Workflow for PRs that would affect Contrib
NathanielRN Nov 14, 2020
6b48413
Detail guidelines for changing repo SHAs
NathanielRN Nov 17, 2020
1d32504
Merge branch 'master' into core-pr-workflow
Nov 18, 2020
77bfbce
Merge branch 'master' into core-pr-workflow
Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,24 @@ $ 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 (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.

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)
Comment on lines +114 to +116
Copy link
Contributor Author

@NathanielRN NathanielRN Nov 18, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Optionally you can not do this, and just wait for the Contrib PR to get merged. The Contrib PR getting merged proves this Core PR is good because it uses this Core PR change!

Running it is just an optional sanity check for the Maintainers wanting to merge the Core PR.

Once Contrib PR is merged, since this points to master, you can just rerun tests and see it all work.

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

* If the PR is not ready for review, please put `[WIP]` in the title, tag it
Expand All @@ -113,6 +131,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.
Expand Down