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

feat: add optional job summary-title parameter #1056

Merged
merged 3 commits into from
Oct 31, 2023

Conversation

MikeMcC399
Copy link
Collaborator

This PR adds an optional parameter summary-title to the cypress-io/github-action.

If specified, then the summary-title replaces the default Job Summary title "Cypress Results". The title is displayed at the top of a job summary.

This is especially useful when cypress-io/github-action is called in more than one step in a GitHub Actions workflow, so that each job summary can be easily identified with individual summary titles showing which step it came from.

example-chrome

summary-title is applied to the example-chrome workflow.

BEFORE

example-chrome_before

AFTER

example-chrome_after

summary-title is here defined as "Chrome headless" in the first instance and "Chrome headed" in the second instance.

example-chrome is the only example workflow in this repo with more than one call of cypress-io/github-action in a single job.

Documentation

  • The parameter summary-title is added to the README and some inconsistencies regarding the description of the parameter publish-summary are removed.

Verification

  • View the log of example-chrome and confirm that the Job Summary uses the customized headings "Chrome headless" in the first instance and "Chrome headed" in the second instance
  • View the log of example-basic and confirm that the Job Summary heading shows "Cypress Results"

References

@cypress-app-bot
Copy link

@MikeMcC399
Copy link
Collaborator Author

@MikeMcC399

This comment was marked as resolved.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review October 15, 2023 16:01
@alex1701c
Copy link

Thanks for the PR! This perfectly fits the need I described in the issue :)

The code looks also good and the change is well documented.

@MikeMcC399
Copy link
Collaborator Author

@alex1701c

Thanks for the PR! This perfectly fits the need I described in the issue :)

The code looks also good and the change is well documented.

Thanks for the positive comments and your confirmation! Now it's over to the Cypress team to see if they agree to merge it.

@MikeMcC399 MikeMcC399 force-pushed the summary-title branch 3 times, most recently from 90015ba to 2dc7382 Compare October 20, 2023 16:11
@mschile mschile added the type: feature feature request label Oct 23, 2023
@MikeMcC399
Copy link
Collaborator Author

@mschile

Is there any chance you could also look at this enhancement PR?

@emilyrohrbough emilyrohrbough merged commit ebe8b24 into cypress-io:master Oct 31, 2023
68 checks passed
Copy link

🎉 This PR is included in version 6.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

Make table title configurable or based on step name
6 participants