Fix potential github action smells #3449
Conversation
- Avoid running CI related actions when no source code has changed - Avoid executing scheduled workflows on forks - Avoid jobs without timeouts
|
Also, a thought for future consideration for us before it disappears from my head again: Especially with regards to Roslyn analyzers/generators, we may want to consider caching, so that they don't have to get built every time, unless one of the analyzer projects is actually modified. Would speed up the build actions. Efficiency of those actions does matter, because there is a limit to how much execution time is allowed per month. |
| @@ -4,6 +4,8 @@ on: | |||
| push: | |||
| # only publish v2 (main or develop); v2 is published via the Terminal.GuiV2Docs repo | |||
There was a problem hiding this comment.
The comment here is not quite accurate with what this actually does.
| @@ -29,6 +29,7 @@ jobs: | |||
| # Consider using larger runners for possible analysis time improvements. | |||
| runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} | |||
There was a problem hiding this comment.
We could clean this up, too, if we use an actual matrix.
And the default comments from the template are not relevant for us, so they could go away.
There was a problem hiding this comment.
Actually... This is codeQL scanning and we do not have OS-specific dependencies.
We could do it on just one runner for this workflow unless anyone has any thoughts otherwise.
There was a problem hiding this comment.
Out of curiosity, what runner would in that case take your preference? The Ubuntu one?
There was a problem hiding this comment.
May as well be that one. Likely to have the lowest total running time cost.
| @@ -29,6 +29,7 @@ jobs: | |||
| # Consider using larger runners for possible analysis time improvements. | |||
| runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} | |||
| timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} | |||
| if: github.repository == 'gui-cs/Terminal.Gui'|| github.event_name == 'schedule' | |||
There was a problem hiding this comment.
This is the best part of it all. Thanks for getting fed up and doing it! :)
It's so noisy for forks, for various other reasons.
There was a problem hiding this comment.
No worries, thank you for the feedback, very appreciated! 馃槃
Fixes
Hey! 馃檪
I want to contribute the following changes to your workflow:
(These changes are part of a research Study at TU Delft looking at GitHub Action Smells. Find out more)
Proposed Changes/Todos
Pull Request checklist:
CTRL-K-Dto automatically reformat your files before committing.dotnet testbefore commit///style comments)