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

Fix potential github action smells #3449

Merged
merged 5 commits into from
Jun 26, 2024
Merged

Conversation

ceddy4395
Copy link

Fixes

Hey! 🙂
I want to contribute the following changes to your workflow:

  • Avoid running CI related actions when no source code has changed
  • Avoid executing scheduled workflows on forks
  • Avoid jobs without timeouts

(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:

  • I've named my PR in the form of "Fixes #issue. Terse description."
  • My code follows the style guidelines of Terminal.Gui - if you use Visual Studio, hit CTRL-K-D to automatically reformat your files before committing.
  • My code follows the Terminal.Gui library design guidelines
  • I ran dotnet test before commit
  • I have made corresponding changes to the API documentation (using /// style comments)
  • My changes generate no new warnings
  • I have checked my code and corrected any poor grammar or misspellings
  • I conducted basic QA to assure all features are working

- Avoid running CI related actions when no source code has changed
- Avoid executing  scheduled workflows on forks
- Avoid jobs without timeouts
@ceddy4395 ceddy4395 requested a review from tig as a code owner May 5, 2024 19:20
Copy link
Collaborator

@dodexahedron dodexahedron left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks!

Plenty more we could do, too, but these hit some really big sources of noise. 👍

@dodexahedron
Copy link
Collaborator

dodexahedron commented May 7, 2024

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.

Copy link
Collaborator

@dodexahedron dodexahedron left a comment

Choose a reason for hiding this comment

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

Still fine to me, regardless of comments I just added.

Those are notes for me while I'm completely re-working things and aren't related to the changes made.

.github/workflows/api-docs.yml Show resolved Hide resolved
.github/workflows/codeql.yml Show resolved Hide resolved
.github/workflows/codeql.yml Show resolved Hide resolved
@tig
Copy link
Collaborator

tig commented May 30, 2024

Is this ready for me to merge?

@tig tig added this to the v1.17.1 milestone Jun 9, 2024
@tig tig self-assigned this Jun 9, 2024
@dodexahedron
Copy link
Collaborator

Hey @tig :

Closely related to this, and also might influence what gets added to the gh marketplace action I'm working on:

What do you have the "Actions permissions" and "Workflow Permissions" set to for this repository, under settings > actions > general? I wanna be sure this repo is covered from the start, since it was the original catalyst for making me do it now rather than [undefined future time range] in the first place. :)

And do you have any environments configured? (that's not important - just surveying what's in use here).

And any defined rulesets or branch/tag protections?

Also, any difficulties or wish list items vis-a-vis the actions/workflows/deployment/builds/etc?

Aside from splitting the analyzers - that is dependent on these other tasks I've got outstanding.

@tig tig merged commit 856950b into gui-cs:develop Jun 26, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants