Skip to content

Commit 36a32b8

Browse files
authored
Some more taskfile improvements (#1382)
* Merge swagger-gen into docs. * Rename mock-gen to gen, since it is a general-purpose code gen command.
1 parent 2b32116 commit 36a32b8

File tree

3 files changed

+16
-20
lines changed

3 files changed

+16
-20
lines changed
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Swagger
1+
name: Codegen
22

33
on:
44
workflow_call:
@@ -8,7 +8,7 @@ permissions:
88

99
jobs:
1010
swagger:
11-
name: Verify Swagger
11+
name: Verify code generation
1212
runs-on: ubuntu-latest
1313

1414
steps:
@@ -21,16 +21,16 @@ jobs:
2121
with:
2222
version: 3.x
2323
repo-token: ${{ secrets.GITHUB_TOKEN }}
24-
- name: Install swagger
25-
run: task swagger-install
26-
- name: Generate swagger files
27-
run: task swagger-gen
24+
- name: Install mockgen
25+
run: task mock-install
26+
- name: Generate code files
27+
run: task gen
2828
- name: Check for changes
2929
run: |
3030
if ! git diff --exit-code docs/server/; then
31-
echo "❌ Swagger files are not up to date!"
32-
echo "Please run 'task swagger-gen' or 'swag init -g pkg/api/server.go --v3.1 -o docs/server' and commit the changes."
31+
echo "❌ Generated code files are not up to date!"
32+
echo "Please run 'task gen' and commit the changes."
3333
exit 1
3434
else
35-
echo "✅ Swagger files are up to date!"
35+
echo "✅ Generated code files are up to date!"
3636
fi

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ task test-e2e
4141
# Run all tests (unit and e2e)
4242
task test-all
4343

44-
# Generate OpenAPI/Swagger documentation
45-
task swagger-gen
44+
# Generate mocks
45+
task gen
4646

4747
# Generate CLI documentation
4848
task docs

Taskfile.yml

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,23 @@ includes:
88
tasks:
99
docs:
1010
desc: Regenerate the docs
11+
deps: [swagger-install]
1112
cmds:
1213
- rm -rf docs/cli/*
1314
- go run cmd/help/main.go --dir docs/cli
15+
- swag init -g pkg/api/server.go --v3.1 -o docs/server
1416

1517
swagger-install:
1618
desc: Install the swag tool for OpenAPI/Swagger generation
1719
cmds:
1820
- go install github.com/swaggo/swag/v2/cmd/swag@latest
1921

20-
swagger-gen:
21-
desc: Generate OpenAPI/Swagger documentation
22-
deps: [swagger-install]
23-
cmds:
24-
- swag init -g pkg/api/server.go --v3.1 -o docs/server
25-
2622
mock-install:
2723
desc: Install the mockgen tool for mock generation
2824
cmds:
2925
- go install go.uber.org/mock/mockgen@latest
3026

31-
mock-gen:
27+
gen:
3228
desc: Generate mock files using go generate
3329
deps: [mock-install]
3430
cmds:
@@ -64,7 +60,7 @@ tasks:
6460

6561
test:
6662
desc: Run unit tests (excluding e2e tests)
67-
deps: [mock-gen]
63+
deps: [gen]
6864
cmds:
6965
- task: test-unixlike
7066
platforms: [linux, darwin]
@@ -140,7 +136,7 @@ tasks:
140136

141137
build:
142138
desc: Build the binary
143-
deps: [mock-gen]
139+
deps: [gen]
144140
vars:
145141
VERSION:
146142
sh: git describe --tags --always --dirty --match "v*" || echo "dev"

0 commit comments

Comments
 (0)