omsf-eco-infra / gha-runner

A simple GitHub Action for creating cloud-based self-hosted runners.
MIT License
0 stars 3 forks source link

docs: updated to include a new way to break down start/stop #10

Closed ethanholz closed 4 months ago

ethanholz commented 4 months ago

This PR aims to improve upon the lack of clear guidance on what is required for "start" vs "stop" actions related to #8.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.11%. Comparing base (24caa5b) to head (967c9a6).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #10 +/- ## ======================================= Coverage 94.11% 94.11% ======================================= Files 3 3 Lines 289 289 ======================================= Hits 272 272 Misses 17 17 ``` | [Flag](https://app.codecov.io/gh/omsf-eco-infra/gha-runner/pull/10/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omsf-eco-infra) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/omsf-eco-infra/gha-runner/pull/10/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omsf-eco-infra) | `94.11% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omsf-eco-infra#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ethanholz commented 4 months ago

@dwhswenson looking for guidance on if this is a bit clearer of an image around what is uses in which action. Open to improvements!

ethanholz commented 4 months ago

Agreed, more than happy to add these additions for clarity!

ethanholz commented 4 months ago

Added some new areas for clarity. The CI probably shouldn't update unless we are actively updating code, codecov and pytest runs are not necessary when updating docs alone.

@dwhswenson this is ready for re-review.