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

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
188 changes: 98 additions & 90 deletions .github/workflows/core_contrib_test_0.yml
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 9 additions & 1 deletion .github/workflows/generate_workflows_lib/src/generate_workflows_lib/core_contrib_test.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/generate_workflows_lib/src/generate_workflows_lib/lint.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

Does this need to be${{ github.repository }} so users can run tests of contrib forks too? Just going off of symmetry here

Copy link
Contributor Author

@jsoref jsoref Jan 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Sorry, i can't think through what it should be at this time. If i have time/energy when I'm not at work, I can try to reason it out.

what I put here is almost certainly wrong, but the various templates and indirections are making me way too dizzy.

Copy link
Member

@emdneto emdneto Jan 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@aabmass I think this is not needed, because checkout action already does the trick for us, including forks.
Example In my fork: https://github.com/emdneto/opentelemetry-python-contrib/actions/runs/12788418223/job/35649787442

This variable has no use though

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In principle, I believe, this could be needed if someone was trying to test a change to their opentelemetry-python repository that needed changes to their opentelemetry-python-contrib repository at the same time (which is more or less what we're looking at in open-telemetry/opentelemetry-python#4388 where things conceptually didn't work for https://github.com/jsoref/opentelemetry-python/actions/runs/12793563878 because the callee doesn't yet have the required feature).

I'm not saying it's working, but I suspect a thing like it would be needed. I'm also not entirely certain it would always work/would work in this case (I think you can't really programmatically change a called workflow target, so in this specific case it wouldn't, but for a normal case, of code as opposed to workflow dependencies, I think it'd be useful).

CONTRIB_REPO_SHA: main
PIP_EXISTS_ACTION: w

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/generate_workflows_lib/src/generate_workflows_lib/misc.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/generate_workflows_lib/src/generate_workflows_lib/test.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/lint_0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/misc_0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test_0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test_1.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test_2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
CORE_REPO=check-spelling-sandbox/opentelemetry-python
GITHUB_REPOSITORY=your-fork/opentelemetry-python tox

Based on my previous comment

CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
```

Expand Down
3 changes: 2 additions & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Copy link
Member

@emdneto emdneto Jan 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I would say to have less intrusive changes to CI, maybe just use the GITHUB_REPOSITORY runtime environment variable here? Like

Suggested change
CORE_REPO=git+https://github.com/{env:CORE_REPO:open-telemetry/opentelemetry-python}.git@{env:CORE_REPO_SHA}
CORE_REPO=git+https://github.com/{env:GITHUB_REPOSITORY:open-telemetry/opentelemetry-python}.git@{env:CORE_REPO_SHA}

At CI this will point to the current owner and repository name, so when running in your fork, it should match your check-spelling-sandbox/opentelemetry-python. This will make tox look at your fork+revision correctly

; 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,
Expand Down
Loading