Adds additional support for Github enterprise usecases #548
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…st merge to the default branch. This is functionally equivalent to the currently supported pattern of pushing to the default branch.
Adds support for figuring out a github host from the `GITHUB_BASE_URL` config and using this value in generated coverage artifacts rather than hardcoding them to "github.com"
for more information, see https://pre-commit.ci
|
Admin commands cheatsheet:
|
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
for more information, see https://pre-commit.ci
…iel-anya/python-coverage-comment-action into additional-support-for-gh-enterprise
for more information, see https://pre-commit.ci
ewjoachim
reviewed
Jul 13, 2025
There was a problem hiding this comment.
That is a stellar contribution 🤩
I'm sorry it took so long to find the time to review it.
I think what it mainly needs is documentation in README. In particular:
- That you can use the pull_request merged event
- How to setup GH pages
- Maybe add some details on how it works for GHE ?
coverage_comment/main.py
Outdated
Comment on lines
77
to
78
| with open(event_path, "r") as event_file: | ||
| event_payload = json.load(event_file) |
There was a problem hiding this comment.
We use Pathlib everywhere else in the project, and event_path is already a path
Suggested change
| with open(event_path, "r") as event_file: | |
| event_payload = json.load(event_file) | |
| event_payload = json.loads(event_path.read_text()) |
coverage_comment/activity.py
Outdated
| ) -> str: | ||
| """Find the activity to perform based on the event type and payload.""" | ||
| if event_name == "workflow_run": | ||
| return "post_comment" | ||
|
|
||
| if (event_name == "push" and is_default_branch) or event_name == "schedule": | ||
| if (event_name == "push" and is_default_branch) or (event_name == "pull_request" and event_action == "merged" and is_default_branch) or event_name == "schedule": |
There was a problem hiding this comment.
I think there should be a mention of this in the README too?
| @@ -47,7 +47,7 @@ function create-repo(){ | |||
| repo_dirname=$(basename ${GITHUB_REPOSITORY}) | |||
| mv "${repo_dirname}/"{*,.*} . | |||
| rmdir "${repo_dirname}" | |||
| git pull --ff-only origin master | |||
| git pull --ff-only origin main | |||
ewjoachim
reviewed
Jul 13, 2025
Comment on lines
+66
to
+72
| # Special case for GitHub.com API | ||
| if netloc == "api.github.com": | ||
| host_domain = "github.com" | ||
| # Special case for GitHub.com with port (less common but good practice) | ||
| elif netloc.startswith("api.github.com:"): | ||
| # Remove 'api.' prefix but keep the port | ||
| host_domain = netloc.replace("api.", "", 1) |
There was a problem hiding this comment.
Suggested change
| # Special case for GitHub.com API | |
| if netloc == "api.github.com": | |
| host_domain = "github.com" | |
| # Special case for GitHub.com with port (less common but good practice) | |
| elif netloc.startswith("api.github.com:"): | |
| # Remove 'api.' prefix but keep the port | |
| host_domain = netloc.replace("api.", "", 1) | |
| # Special case for GitHub.com API (including possible port) | |
| if re.match(r"api\.github\.com(:|$)", netloc): | |
| # Remove 'api.' prefix but keep the port | |
| host_domain = netloc.removeprefix("api.") |
|
Oh, and there are 4 lines missing coverage 😅 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
5764cba: Adds support for figuring out a Github host from the
GITHUB_BASE_URLconfig, and using this value in generated coverage artifacts. The usecase here is that, when this action is used in the enterprise environment, coverage artifacts like html files and README docs point togithub.com/...which is not what we'd want.07a88e1: Adds support for saving coverage artifacts on
PR merged to default branchevents which is functionally equivalent to the currently supported path of saving coverage artifacts oncommit pushed to default branchevents.78a7324: Adds support for generating Github Pages based coverage report links.
Tested all changes in a Github enterprise environment and they've been working fine for a while now.