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

Improve example jobs in README.md #255

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

guyzyl
Copy link

@guyzyl guyzyl commented Oct 12, 2022

Improve the example jobs in README.md by:

  • Making the job fail if one of the steps fails
  • Show ✅/❌instead of success/failure to make it easier to see if and which step failed

This is what it looks like:
image

@guyzyl guyzyl requested a review from a team as a code owner October 12, 2022 14:47
@cspollar
Copy link
Contributor

cspollar commented May 2, 2023

This is a nice improvement - just added a version of it to one of my repos. If someone wants to get really fancy - I'd love to see an example that uses GITHUB_STEP_SUMMARY.

Edit: Adding a GITHUB_STEP_SUMMARY was relatively easy. Although, I had to add line breaks between the heading lines in output (markdown, can be finicky).

 // 5. Update GITHUB_STEP_SUMMARY
await core.summary
    .addHeading('Results')
    .addRaw(output)
    .write()

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.

2 participants