Sentinel icon indicating copy to clipboard operation
Sentinel copied to clipboard

Fix potential github action smells

Open ceddy4395 opened this issue 9 months ago • 1 comments

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)

ceddy4395 avatar May 24 '24 12:05 ceddy4395