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.

Sign up for GitHub

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 YAML for CLI command generation #666

Merged
merged 17 commits into from
Sep 23, 2024
Merged

Use YAML for CLI command generation #666

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
ca361f3
ported commands.md to commands.yml
yuandrew Sep 12, 2024
bb7c12d
current YAML draft
yuandrew Sep 13, 2024
d04fb17
go run ./temporalcli/internal/cmd/gen-commands works but make all doe…
yuandrew Sep 17, 2024
1651a7b
make all works
yuandrew Sep 17, 2024
ea427a3
Merge branch 'main' into command-yaml-generation
yuandrew Sep 17, 2024
07ec2cb
tests pass
yuandrew Sep 18, 2024
96b6240
cleanup code, add instructions to top of YML
yuandrew Sep 18, 2024
2cedef7
don't support bool default
yuandrew Sep 18, 2024
b119093
clean up from comparing commands.gen.go
yuandrew Sep 18, 2024
40be057
missed a small change
yuandrew Sep 18, 2024
3b425e5
regen commands.gen.go
yuandrew Sep 18, 2024
ee16399
remove all newlines from option descriptions
yuandrew Sep 19, 2024
4cf572b
fix some more description spacing
yuandrew Sep 19, 2024
fb39d60
PR comments
yuandrew Sep 23, 2024
c53171b
minor doc fix
yuandrew Sep 23, 2024
df2e643
missed a commands.md reference
yuandrew Sep 23, 2024
f9f00c5
removing commands.md again, must have resurfaced from a rebase
yuandrew Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Example to run a single test case:

## Adding/updating commands

First, update [commands.md](temporalcli/commandsmd/commands.md) following the rules in that file. Then to regenerate the
First, update [commands.yml](temporalcli/commandsgen/commands.yml) following the rules in that file. Then to regenerate the
[commands.gen.go](temporalcli/commands.gen.go) file from code, simply run:

go run ./temporalcli/internal/cmd/gen-commands
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ all: gen build

gen: temporalcli/commands.gen.go

temporalcli/commands.gen.go: temporalcli/commandsmd/commands.md
temporalcli/commands.gen.go: temporalcli/commandsgen/commands.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still references commands.md. In a perfect world this would have failed CI with something like:

No rule to make target 'temporalcli/commandsgen/commands.md', needed by 'temporalcli/commands.gen.go'

But unfortunately this Makefile is an untested/undocumented thing just sitting in the repo

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, thanks for catching this!

go run ./temporalcli/internal/cmd/gen-commands

build:
Expand Down
556 changes: 281 additions & 275 deletions temporalcli/commands.gen.go
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading