Skip to content

Commit 6a60ac3

Browse files
committed
ci: clarify workflow step names in GitHub UI
1 parent 96d2194 commit 6a60ac3

1 file changed

Lines changed: 36 additions & 26 deletions

File tree

.github/workflows/ci.yml

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,33 @@ jobs:
1313
lint:
1414
runs-on: ubuntu-latest
1515
steps:
16-
- uses: actions/checkout@v4
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
1718
with:
1819
fetch-depth: 0
1920

20-
- uses: actions/setup-go@v5
21+
- name: Set up Go
22+
uses: actions/setup-go@v5
2123
with:
2224
go-version: ${{ env.GO_VERSION }}
2325

24-
- name: golangci-lint (includes gosec)
26+
- name: Run lint checks (golangci-lint + gosec)
2527
uses: golangci/golangci-lint-action@v7
2628
with:
2729
version: v2.8.0
2830

29-
- name: Check generated manifests are up to date
31+
- name: Verify generated manifests are committed
3032
run: |
3133
make manifests
3234
git diff --exit-code
3335
34-
- name: Install gitleaks
36+
- name: Install gitleaks CLI
3537
run: |
3638
curl -sSfL https://github.com/gitleaks/gitleaks/releases/download/v8.24.2/gitleaks_8.24.2_linux_x64.tar.gz -o /tmp/gitleaks.tar.gz
3739
tar -xzf /tmp/gitleaks.tar.gz -C /tmp
3840
sudo install -m 0755 /tmp/gitleaks /usr/local/bin/gitleaks
3941
40-
- name: Gitleaks secret scan
42+
- name: Scan repository for secrets (gitleaks)
4143
run: gitleaks git --redact --verbose
4244

4345
build:
@@ -47,19 +49,21 @@ jobs:
4749
matrix:
4850
arch: [amd64, arm64]
4951
steps:
50-
- uses: actions/checkout@v4
52+
- name: Checkout repository
53+
uses: actions/checkout@v4
5154

52-
- uses: actions/setup-go@v5
55+
- name: Set up Go
56+
uses: actions/setup-go@v5
5357
with:
5458
go-version: ${{ env.GO_VERSION }}
5559

56-
- name: Build operator
60+
- name: Build operator binary
5761
env:
5862
GOARCH: ${{ matrix.arch }}
5963
CGO_ENABLED: "0"
6064
run: go build ./cmd/operator/...
6165

62-
- name: Build node agent
66+
- name: Build node agent binary
6367
env:
6468
GOARCH: ${{ matrix.arch }}
6569
CGO_ENABLED: "0"
@@ -69,23 +73,25 @@ jobs:
6973
runs-on: ubuntu-latest
7074
needs: lint
7175
steps:
72-
- uses: actions/checkout@v4
76+
- name: Checkout repository
77+
uses: actions/checkout@v4
7378

74-
- uses: actions/setup-go@v5
79+
- name: Set up Go
80+
uses: actions/setup-go@v5
7581
with:
7682
go-version: ${{ env.GO_VERSION }}
7783

78-
- name: Install setup-envtest
84+
- name: Install envtest tooling
7985
run: |
8086
go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
8187
echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
8288
83-
- name: Run tests
89+
- name: Run unit/integration tests (non-E2E)
8490
run: |
8591
KUBEBUILDER_ASSETS=$(setup-envtest use -p path) \
8692
go test -race -coverprofile=coverage.out ./...
8793
88-
- name: Upload coverage
94+
- name: Upload coverage report
8995
uses: codecov/codecov-action@v4
9096
with:
9197
files: coverage.out
@@ -95,18 +101,19 @@ jobs:
95101
runs-on: ${{ vars.E2E_RUNNER_LABEL }}
96102
needs: test
97103
steps:
98-
- uses: actions/checkout@v4
104+
- name: Checkout repository
105+
uses: actions/checkout@v4
99106

100-
- name: Create Talos cluster
107+
- name: Create Talos E2E cluster
101108
run: talosctl cluster create --provisioner docker --name imp-e2e
102109

103110
- name: Apply CRDs
104111
run: kubectl apply -f config/crd/bases/
105112

106-
- name: Run E2E tests
113+
- name: Run E2E suite
107114
run: go test -v -tags e2e ./test/e2e/...
108115

109-
- name: Cleanup
116+
- name: Destroy Talos E2E cluster
110117
if: always()
111118
run: talosctl cluster destroy --name imp-e2e
112119

@@ -115,28 +122,31 @@ jobs:
115122
runs-on: ubuntu-latest
116123
needs: [lint, build]
117124
steps:
118-
- uses: actions/checkout@v4
125+
- name: Checkout repository
126+
uses: actions/checkout@v4
119127

120-
- uses: actions/setup-go@v5
128+
- name: Set up Go
129+
uses: actions/setup-go@v5
121130
with:
122131
go-version: ${{ env.GO_VERSION }}
123132

124-
- uses: helm/kind-action@v1
133+
- name: Create Kind cluster
134+
uses: helm/kind-action@v1
125135
with:
126136
cluster_name: imp-e2e
127137

128-
- name: Install Helm
138+
- name: Install Helm CLI
129139
uses: azure/setup-helm@v4
130140

131-
- name: Build E2E images
141+
- name: Build local E2E images
132142
run: |
133143
docker build -f Dockerfile.operator -t local/imp-operator:e2e .
134144
docker build -f Dockerfile.agent -t local/imp-agent:e2e .
135145
136-
- name: Load E2E images into Kind
146+
- name: Load local E2E images into Kind
137147
run: |
138148
kind load docker-image local/imp-operator:e2e --name imp-e2e
139149
kind load docker-image local/imp-agent:e2e --name imp-e2e
140150
141-
- name: Run E2E tests
151+
- name: Run smoke E2E suite
142152
run: go test -tags e2e ./test/e2e/... -v -timeout 15m -ginkgo.label-filter="smoke"

0 commit comments

Comments
 (0)