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.

Sign up for GitHub

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

Jump to bottom

Fix potential github action smells #3402

Open
wants to merge 2 commits into
base: 1.8
Choose a base branch
from
Open

Fix potential github action smells #3402

wants to merge 2 commits into from

Conversation

ceddy4395
Copy link

@ceddy4395 ceddy4395 commented May 24, 2024 •
edited
Loading

Describe what this PR does / why we need it

Hey! 🙂
I've made the following changes to your workflow:

  • Avoid installing packages without version
    • When installing a package without a version, the latest version will always be installed, even when braking changes have been released. To avoid this causing failing pipelines a version should be specified which is known to be compatible with the code base.
  • Run tests on multiple OS's
    • Testing on different OS's makes sure that they are currently and in the future supported when new changes are added to the code base.
  • Avoid workflows without comments
    • Workflows can be used as a form of documentation, and therefore it helps if everything is clearly explained. This especially holds for when a workflow failed and a developer is trying to figure out what and why it failed.

Does this pull request fix one issue?

Describe how you did it

Describe how to verify it

Special notes for reviews

(These changes are part of a research Study at TU Delft looking at GitHub Action Smells. Find out more)
@CLAassistant
Copy link

CLAassistant commented May 24, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.
@ceddy4395
Fix gha smells:
665d2da 
- Use fixed version for runs-on argument
- Run tests on multiple OS's
- Avoid workflows without comments
@ceddy4395 ceddy4395 force-pushed the fix-gha-smells branch 3 times, most recently from ca7b3a1 to e61b86b Compare May 28, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants
@ceddy4395 @CLAassistant