fix (ci): Allow opentelemetry-python forks to use CI

jsoref · jsoref · commit 81102a855e8c · 2025-01-15T09:53:47.000-05:00
Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;
diff --git a/.github/workflows/core_contrib_test_0.yml b/.github/workflows/core_contrib_test_0.yml
diff --git a/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/core_contrib_test.yml.j2 b/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/core_contrib_test.yml.j2
@@ -6,14 +6,22 @@ name: Core Contrib Test {{ file_number }}
 on:
   workflow_call:
     inputs:
+      CORE_REPO:
+        required: false
+        type: string
       CORE_REPO_SHA:
         required: true
         type: string
+      CONTRIB_REPO:
+        required: false
+        type: string
       CONTRIB_REPO_SHA:
         required: true
         type: string
 env:
+  CORE_REPO: ${% raw %}{{ inputs.CORE_REPO || 'open-telemetry/opentelemetry-python' }}{% endraw %}
   CORE_REPO_SHA: ${% raw %}{{ inputs.CORE_REPO_SHA }}{% endraw %}
+  CONTRIB_REPO: ${% raw %}{{ inputs.CONTRIB_REPO || 'open-telemetry/opentelemetry-python-contrib' }}{% endraw %}
   CONTRIB_REPO_SHA: ${% raw %}{{ inputs.CONTRIB_REPO_SHA }}{% endraw %}
   PIP_EXISTS_ACTION: w
 
@@ -27,7 +35,7 @@ jobs:
       - name: Checkout contrib repo @ SHA - ${% raw %}{{ env.CONTRIB_REPO_SHA }}{% endraw %}
         uses: actions/checkout@v4
         with:
-          repository: open-telemetry/opentelemetry-python-contrib
+          repository: ${% raw %}{{ env.CONTRIB_REPO }}{% endraw %}
           ref: ${% raw %}{{ env.CONTRIB_REPO_SHA }}{% endraw %}
 
       - name: Set up Python 3.8
diff --git a/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/lint.yml.j2 b/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/lint.yml.j2
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/misc.yml.j2 b/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/misc.yml.j2
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/test.yml.j2 b/.github/workflows/generate_workflows_lib/src/generate_workflows_lib/test.yml.j2
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/lint_0.yml b/.github/workflows/lint_0.yml
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/misc_0.yml b/.github/workflows/misc_0.yml
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/test_0.yml b/.github/workflows/test_0.yml
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/test_1.yml b/.github/workflows/test_1.yml
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/.github/workflows/test_2.yml b/.github/workflows/test_2.yml
@@ -10,7 +10,9 @@ on:
   pull_request:
 
 env:
+  CORE_REPO: open-telemetry/opentelemetry-python
   CORE_REPO_SHA: main
+  CONTRIB_REPO: open-telemetry/opentelemetry-python-contrib
   CONTRIB_REPO_SHA: main
   PIP_EXISTS_ACTION: w
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -242,9 +242,12 @@ tox -e py312-test-instrumentation-aiopg
 
 ### Testing against a different Core repo branch/commit
 
-Some of the tox targets install packages from the [OpenTelemetry Python Core Repository](https://github.com/open-telemetry/opentelemetry-python) via pip. The version of the packages installed defaults to the main branch in that repository when tox is run locally. It is possible to install packages tagged with a specific git commit hash by setting an environment variable before running tox as per the following example:
+Some of the tox targets install packages from the [OpenTelemetry Python Core Repository](https://github.com/open-telemetry/opentelemetry-python) via pip.
+The version of the packages installed defaults to the main branch in that repository when tox is run locally.
+It is possible to install packages tagged with a specific git commit hash (optionally in a specific fork) by setting these environment variables before running tox as per the following example:
 
 ```sh
+CORE_REPO=check-spelling-sandbox/opentelemetry-python
 CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
 ```
 
diff --git a/tox.ini b/tox.ini
@@ -682,10 +682,11 @@ allowlist_externals =
   sh
 
 setenv =
+  ; override CORE_REPO via env variable when testing in forks
+  CORE_REPO=git+https://github.com/{env:CORE_REPO:open-telemetry/opentelemetry-python}.git@{env:CORE_REPO_SHA}
   ; override CORE_REPO_SHA via env variable when testing other branches/commits than main
   ; i.e: CORE_REPO_SHA=dde62cebffe519c35875af6d06fae053b3be65ec tox -e <env to test>
   CORE_REPO_SHA={env:CORE_REPO_SHA:main}
-  CORE_REPO=git+https://github.com/open-telemetry/opentelemetry-python.git@{env:CORE_REPO_SHA}
 
 commands_pre =
 ; In order to get a health coverage report,
