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

Use more meaningful variable names in release workflows #100

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Nov 6, 2024

GitHub Actions workflows are used to automatically generate beta tester and production builds of the project.

A separate build is generated for each of the target host types. This is done using a job matrix, which creates a parallel run of the workflow job for each target. The matrix defines variables that provide the data that is specific to each job.

The variable names used previously did not clearly communicate their nature:

  • The variable for the task name was named os
  • The variable for the workflow artifact was named os.name, which was a bit ambiguous

These variable names made it difficult for anyone not intimately familiar with the workings of the workflows to understand their code.

GitHub Actions workflows are used to automatically generate beta tester and production builds of the project.

A separate build is generated for each of the target host types. This is done using a job matrix, which creates a
parallel run of the workflow job for each target. The matrix defines variables that provide the data that is specific to
each job.

The variable names used previously did not clearly communicate their nature:

- The variable for the task name was named "os"
- The variable for the workflow artifact was named "os.name", which was a bit ambiguous

These variable names made it difficult for anyone not intimately familiar with the workings of the workflows to
understand their code.
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Nov 6, 2024
@per1234 per1234 self-assigned this Nov 6, 2024
@per1234 per1234 merged commit c901207 into main Nov 6, 2024
41 checks passed
@per1234 per1234 deleted the workflow-var-names branch November 6, 2024 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant