feat: add optional job summary-title parameter#1056
Merged
Conversation
Collaborator
|
Collaborator
Author
|
813aadd to
b986c04
Compare
This comment was marked as resolved.
This comment was marked as resolved.
|
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. |
Collaborator
Author
Thanks for the positive comments and your confirmation! Now it's over to the Cypress team to see if they agree to merge it. |
90015ba to
2dc7382
Compare
2dc7382 to
0ec9795
Compare
0ec9795 to
662e355
Compare
Collaborator
Author
|
Is there any chance you could also look at this enhancement PR? |
662e355 to
2bbee69
Compare
emilyrohrbough
approved these changes
Oct 31, 2023
jennifer-shehane
approved these changes
Oct 31, 2023
|
🎉 This PR is included in version 6.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
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.
This PR adds an optional parameter
summary-titleto thecypress-io/github-action.If specified, then the
summary-titlereplaces 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-actionis 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-titleis applied to the example-chrome workflow.BEFORE
AFTER
summary-titleis 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-actionin a single job.Documentation
summary-titleis added to the README and some inconsistencies regarding the description of the parameterpublish-summaryare removed.Verification
References