Skip to content

chore: Add github step summaries for e2e test suites#2670

Open
chmouel wants to merge 1 commit intotektoncd:mainfrom
chmouel:add-github-step-summary
Open

chore: Add github step summaries for e2e test suites#2670
chmouel wants to merge 1 commit intotektoncd:mainfrom
chmouel:add-github-step-summary

Conversation

@chmouel
Copy link
Copy Markdown
Member

@chmouel chmouel commented Apr 9, 2026

📝 Description of the Change

Added a workflow step to generate markdown summaries of test results
directly in the continuous integration interface. Providing this
information in the summary view helped developers identify failing
tests immediately without needing to dig through raw execution logs.

Signed-off-by: Chmouel Boudjnah chmouel@redhat.com

🔗 Linked GitHub Issue

Fixes #

🧪 Testing Strategy

  • Unit tests
  • Integration tests
  • End-to-end tests
  • Manual testing
  • Not Applicable

🤖 AI Assistance

AI assistance can be used for various tasks, such as code generation,
documentation, or testing.

Please indicate whether you have used AI assistance
for this PR and provide details if applicable.

  • I have not used any AI assistance for this PR.
  • I have used AI assistance for this PR.

Important

Slop will be simply rejected, if you are using AI assistance you need to make sure you
understand the code generated and that it meets the project's standards. you
need at least know how to run the code and deploy it (if needed). See
startpaac to make it easy
to deploy and test your code changes.

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Claude noreply@anthropic.com

✅ Submitter Checklist

  • 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • ✨ I have ensured my commit message prefix (e.g., fix:, feat:) matches the "Type of Change" I selected above.
  • ♽ I have run make test and make lint locally to check for and fix any
    issues. For an efficient workflow, I have considered installing
    pre-commit and running pre-commit install to
    automate these checks.
  • 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

Added a workflow step to generate markdown summaries of test results
directly in the continuous integration interface. Providing this
information in the summary view helped developers identify failing
tests immediately without needing to dig through raw execution logs.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new Python script, hack/generate_github_summary.py, designed to parse gotestsum JSON output and generate a Markdown summary for GitHub Step Summaries. It also updates the hack/gh-workflow-ci.sh script to integrate this new functionality. Review feedback suggests improving the Python script's error handling for missing files and optimizing the sorting logic within loops for better performance. Additionally, suggestions were made to enhance the bash script's robustness by adding shell options and calling the Python script more idiomatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant