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.

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

ci: display HTML test report URLs in check run summaries (#252) #262

Closed
wants to merge 40 commits into from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 23, 2025

Display HTML test report URLs in check run summaries

Resolves #252

Description

After extensive testing of GitHub Actions check run behavior, we've found that GitHub Actions consistently overrides any custom details URLs with its own workflow run URLs. This appears to be a platform-level behavior that cannot be bypassed. As a result, this PR implements an alternative approach that ensures the HTML test report URLs are prominently displayed in the check run summaries.

Changes:

  • Added GitHub Checks marketplace action (LouisBrunner/[email protected]) for reliable check run creation
  • Created separate check runs for test reports with clear naming
  • Added HTML report URLs prominently in check run summaries
  • Added proper error handling for missing HTML reports
  • Added dummy workflow to demonstrate and test check run behavior

Key Findings:

  • GitHub Actions automatically overrides check run details URLs with workflow run URLs
  • This behavior is consistent across different approaches:
    • Direct GitHub API calls
    • GitHub Checks marketplace action
    • Post-job check run creation
    • Different conclusion statuses (success/failure/neutral)
  • Solution: Display HTML report URLs in check run summaries for easy access

Testing

The changes can be tested by:

  1. Running the dummy check result workflow to verify check run creation
  2. Observing that the HTML report URL is clearly displayed in the check run summary
  3. Running the connector tests workflow (after approval)
  4. Verifying that test report check runs show proper status and HTML report links
  5. Confirming proper error handling when report generation fails

Link to Devin run: https://app.devin.ai/sessions/b2ee5a94ec1246878d249ba434684b31

devin-ai-integration bot and others added 19 commits January 23, 2025 17:41
Copy link
Contributor Author

Original prompt:

Hey, @Devin. Can you help with this issue. Let's confirm the plan before you start. <https://github.com/airbytehq/airbyte-python-cdk/issues/252>

Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions github-actions bot added the ci label Jan 23, 2025
@devin-ai-integration devin-ai-integration bot changed the title ci: add dummy workflow for testing check run creation ci: display HTML test report URLs in check run summaries (#252) Jan 24, 2025
Copy link
Contributor Author

Closing this test PR as we've successfully validated the commit status API approach. The working solution will be migrated to the main PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CI: Link to HTML test reports from CI checks list
1 participant