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

Add runner disk info and image version to status report #1825

Merged
merged 12 commits into from
Aug 9, 2023

Conversation

henrymercer
Copy link
Contributor

This PR adds three new fields to the status report:

  • Available disk space on the runner
  • Total disk space on the runner
  • Image version of the runner, for GitHub-hosted runners

We also log a warning if there is less than 2 GB of disk space available at various points in the run. For example, we log a warning if there is less than 2 GB of disk available at the start of init, but not at the end of analyze as the user is unlikely to need much space for the rest of the job. For neatness, we only log the warning once per run, but we continue logging the amount of free disk space in the debug logs.

Commit-by-commit review recommended since we do some refactoring, e.g. pulling out status reporting into its own file.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@henrymercer henrymercer requested a review from a team as a code owner August 7, 2023 15:28
src/status-report.test.ts Fixed Show fixed Hide fixed
src/status-report.test.ts Fixed Show fixed Hide fixed
src/status-report.ts Fixed Show fixed Hide fixed
Comment on lines +291 to +295
{
owner,
repo,
data: statusReportJSON,
},

Check warning

Code scanning / CodeQL

File data in outbound network request

Outbound network request depends on [file data](1). Outbound network request depends on [file data](2).
angelapwen
angelapwen previously approved these changes Aug 8, 2023
Copy link
Contributor

@angelapwen angelapwen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing, thank you for all the refactoring and sorting ✨ a couple of questions for my own curiosity!

.vscode/settings.json Show resolved Hide resolved
src/status-report.ts Show resolved Hide resolved
Copy link
Contributor

@angelapwen angelapwen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call on the changenote!

@henrymercer henrymercer enabled auto-merge August 9, 2023 11:28
@henrymercer henrymercer merged commit 9e4932e into main Aug 9, 2023
@henrymercer henrymercer deleted the henrymercer/disk-telemetry branch August 9, 2023 15:05
@github-actions github-actions bot mentioned this pull request Aug 14, 2023
6 tasks
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