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

Make table title configurable or based on step name #1050

Closed
alex1701c opened this issue Oct 13, 2023 · 6 comments · Fixed by #1056
Closed

Make table title configurable or based on step name #1050

alex1701c opened this issue Oct 13, 2023 · 6 comments · Fixed by #1056
Labels
released type: enhancement New feature or request

Comments

@alex1701c
Copy link

On one of my workflows, I run component and afterward E2E tests. The summary produces two tables with the identical heading "Cypress Results". I'd like to have the step name, a custom specified name or maybe just the hint if those are E2E/component tests in the table headers.

@MikeMcC399
Copy link
Collaborator

MikeMcC399 commented Oct 13, 2023

@alex1701c

This enhancement would be nice to have!

The example-chrome workflow has two steps calling Cypress in one job and the results are not clear since only the job name, not the step names, is shown:

image

The first result summary is actually from the step Chrome headless and the second result summary is from the step Chrome headed.

The results summary is produced using @actions/core and the best description I found was on https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/.

I may have overlooked something, but I couldn't see any obvious way to add the step name automatically into the summary. It may need an enhancement to @actions/core.summary to add the step name automatically.

@MikeMcC399
Copy link
Collaborator

MikeMcC399 commented Oct 15, 2023

@alex1701c

The most flexible solution would be to introduce a parameter to override the default heading "Cypress Results" of the Job Summary. If this were implemented, then the above Job Summary could be changed for instance like this:

example-chrome_after

I plan to submit a PR to implement this suggestion.

@MikeMcC399
Copy link
Collaborator

@alex1701c
Copy link
Author

I may have overlooked something, but I couldn't see any obvious way to add the step name automatically into the summary. It may need an enhancement to @actions/core.summary to add the step name automatically.

I couldn't find one either.

Copy link

🎉 This issue has been resolved in version 6.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@alex1701c
Copy link
Author

Thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants