Skip to content

Commit e5ad1c7

Browse files
committed
Use more meaningful variable names in release workflows
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.
1 parent bfed394 commit e5ad1c7

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

.github/workflows/publish-go-tester-task.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,39 +75,39 @@ jobs:
7575
7676
build:
7777
needs: package-name-prefix
78-
name: Build ${{ matrix.os.name }}
78+
name: Build ${{ matrix.os.artifact-name }}
7979
runs-on: ubuntu-latest
8080

8181
strategy:
8282
matrix:
8383
os:
8484
- task: Windows_32bit
8585
path: "*Windows_32bit.zip"
86-
name: Windows_X86-32
86+
artifact-name: Windows_X86-32
8787
- task: Windows_64bit
8888
path: "*Windows_64bit.zip"
89-
name: Windows_X86-64
89+
artifact-name: Windows_X86-64
9090
- task: Linux_32bit
9191
path: "*Linux_32bit.tar.gz"
92-
name: Linux_X86-32
92+
artifact-name: Linux_X86-32
9393
- task: Linux_64bit
9494
path: "*Linux_64bit.tar.gz"
95-
name: Linux_X86-64
95+
artifact-name: Linux_X86-64
9696
- task: Linux_ARMv6
9797
path: "*Linux_ARMv6.tar.gz"
98-
name: Linux_ARMv6
98+
artifact-name: Linux_ARMv6
9999
- task: Linux_ARMv7
100100
path: "*Linux_ARMv7.tar.gz"
101-
name: Linux_ARMv7
101+
artifact-name: Linux_ARMv7
102102
- task: Linux_ARM64
103103
path: "*Linux_ARM64.tar.gz"
104-
name: Linux_ARM64
104+
artifact-name: Linux_ARM64
105105
- task: macOS_64bit
106106
path: "*macOS_64bit.tar.gz"
107-
name: macOS_64
107+
artifact-name: macOS_64
108108
- task: macOS_ARM64
109109
path: "*macOS_ARM64.tar.gz"
110-
name: macOS_ARM64
110+
artifact-name: macOS_ARM64
111111

112112
steps:
113113
- name: Checkout repository
@@ -130,7 +130,7 @@ jobs:
130130
uses: actions/upload-artifact@v3
131131
with:
132132
path: ${{ env.DIST_DIR }}/${{ matrix.os.path }}
133-
name: ${{ matrix.os.name }}
133+
name: ${{ matrix.os.artifact-name }}
134134

135135
checksums:
136136
needs:

.github/workflows/release-go-task.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121

2222
strategy:
2323
matrix:
24-
os:
24+
task:
2525
- Windows_32bit
2626
- Windows_64bit
2727
- Linux_32bit
@@ -40,7 +40,7 @@ jobs:
4040

4141
- name: Create changelog
4242
# Avoid creating the same changelog for each os
43-
if: matrix.os == 'Windows_32bit'
43+
if: matrix.task == 'Windows_32bit'
4444
uses: arduino/create-changelog@v1
4545
with:
4646
tag-regex: '^v?[0-9]+\.[0-9]+\.[0-9]+.*$'
@@ -55,7 +55,7 @@ jobs:
5555
version: 3.x
5656

5757
- name: Build
58-
run: task dist:${{ matrix.os }}
58+
run: task dist:${{ matrix.task }}
5959

6060
- name: Upload artifacts
6161
uses: actions/upload-artifact@v3

0 commit comments

Comments
 (0)