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: enhance github action summary with detailed repository updates #280

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chrheg
Copy link
Contributor

@chrheg chrheg commented Dec 3, 2024

This pull request introduces functionality to generate and append a job summary to a GitHub step summary file. The changes include updates to the evergreen.py script to create and append the summary, as well as modifications to the README.md to document the new job step. Additionally, new tests have been added to ensure the correctness of the new functionality.

Summary of Changes

Enhancements to evergreen.py:

  • Added code to generate a job summary with details such as organization, follow-up type, dry run status, security updates, and project ID. The summary also includes a table of updated repositories. [1] [2] [3] [4]
  • Introduced a new function append_to_github_summary to append the generated summary content to a specified file.

Documentation Updates:

  • Updated README.md to include a new job step for posting the evergreen job summary to the GitHub step summary file. [1] [2] [3]

Testing:

  • Added a new test class TestAppendToGithubSummary in test_evergreen.py to verify the functionality of the append_to_github_summary function.

@jmeridth
Copy link
Member

jmeridth commented Dec 3, 2024

@chrheg I love this idea. I'm going to test in a personal repo. And you have tests 🎉. Thank you.

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.

2 participants