Commands generator binary by stephanos · Pull Request #875 · temporalio/cli

stephanos · 2025-11-18T22:50:36Z

What was changed

Make gen-commands and gen-docs a binary that can be used any YAML input.

Why?

Temporal wants to re-use the commandsgen tool for other internal CLIs.

It is not supported for users outside of Temporal.

Checklist

Closes
How was this tested:

Any docs updates needed?

stephanos · 2025-11-19T00:16:04Z

.github/workflows/ci.yaml

+          [
+            ubuntu-latest,
+            macos-latest,
+            macos-15-intel,


stephanos · 2025-11-19T19:46:49Z

internal/commandsgen/code.go

 	"sort"
 	"strings"
-
-	"go.temporal.io/server/common/primitives/timestamp"


Copied parseDuration to remove server dependency here.

stephanos · 2025-11-27T00:23:32Z

internal/temporalcli/commands.schedule_test.go

-	s.NoError(res.Err)
-	out := res.Stdout.String()
+	var out string
+	s.EventuallyWithT(func(t *assert.CollectT) {


stephanos · 2025-11-27T00:23:37Z

internal/temporalcli/commands.worker.deployment_test.go

+		assert.Contains(t, res.Stdout.String(), deploymentName1)
+		assert.Contains(t, res.Stdout.String(), version1.BuildID)
+		assert.Contains(t, res.Stdout.String(), deploymentName2)
+		assert.Contains(t, res.Stdout.String(), version2.BuildID)


stephanos · 2025-11-27T00:29:02Z

.github/workflows/ci.yaml

+        if: ${{ matrix.checkGenCommands }}
        run: |
-          go run ./internal/cmd/gen-commands
+          go run ./cmd/gen-commands -pkg temporalcli -context "*CommandContext" < internal/temporalcli/commands.yaml > internal/temporalcli/commands.gen.go


This is where I would invoke make gen but received strong objections last time.

Yes, IMO we should avoid adding platform dependent code. Any contributor on any supported platform should be able to basically run the same commands as our CI does

stephanos · 2025-11-27T00:29:40Z

.github/workflows/ci.yaml

+      - name: Generate docs, confirm working
+        if: ${{ matrix.checkGenCommands }}
+        run: |
+          go run ./cmd/gen-docs -output dist/docs < internal/temporalcli/commands.yaml
+


Better to know immediately if this is broken.

stephanos · 2025-11-29T17:27:48Z

internal/commandsgen/code.go

 	buf         bytes.Buffer
 	allCommands []Command
 	OptionSets  []OptionSets
+	contextType string


Allow custom context name.

stephanos · 2025-11-29T17:29:52Z

internal/temporalcli/commands.gen.go

 	return &s
 }
+
+var reDays = regexp.MustCompile(`(\d+(\.\d*)?|(\.\d+))d`)


As this is generated code, I think it's fine for the var and type to not be at the top here to keep the codegen simple. Similarly, a single generated file seems easier do manage and generate then multiple.

stephanos · 2025-11-29T17:30:28Z

internal/commandsgen/code.go


+// appendGoSource parses a Go source file, registers its imports, and appends
+// everything after the import block to the output buffer.
+func (c *codeWriter) appendGoSource(src string) error {


It was either this, string literals or regex; this seems like the best approach to me.

cretz · 2025-12-01T15:48:30Z

.github/workflows/ci.yaml

+        if: ${{ matrix.checkGenCommands }}
        run: |
-          go run ./internal/cmd/gen-commands
+          go run ./cmd/gen-commands -pkg temporalcli -context "*CommandContext" < internal/temporalcli/commands.yaml > internal/temporalcli/commands.gen.go


Yes, IMO we should avoid adding platform dependent code. Any contributor on any supported platform should be able to basically run the same commands as our CI does

cretz · 2025-12-01T15:50:09Z

internal/cmd/gen-commands/main.go

I think this and the other could also be considered a "hidden" internal sub-command of the existing CLI (probably manually added, not via existing yaml file, which allows it to be easily versioned/downloaded and doesn't require these top-level dirs. The bootstrapping problem is very slight.

That's fair; since it is an internal tool only. 👍

I was saying they could be just commands on the existing binary (but hidden from "help"). Technically a completely different binary is fine too, but you lose the ability to easily download/version this binary.

Oh, sorry, I misread. I have mixed feelings about including it directly in the Temporal CLI; it feels like it shouldn't be including the dev tooling itself.

AFAICS go run github.com/temporalio/cli/internal/cmd/gen-commands@<version> is how you'd run the command generator. And it would respond to the same git tags as the Temporal CLI as it's in the same repo.

Or should we consider moving it to a separate repo; now that we a standalone binary?

I'm ok w/ how you have it now, just a thought of making it a separate command gets all of the packaging/deployment benefits, but what you have here is fine

👍 we can always make adjustments later once we some learnings.

cretz · 2025-12-01T15:50:37Z

cmd/gen-commands/main.go

+	flag.Parse()
+
+	// Read input from stdin
+	yamlBytes, err := io.ReadAll(os.Stdin)


Personal preference is to (also?) accept files for both directions, but it's not a big deal for an internal tool

👍 I'll change it to a file input, no strong opinions on my end

cretz · 2025-12-01T16:03:56Z

CONTRIBUTING.md

+[commands.gen.go](internal/temporalcli/commands.gen.go) file from code, simply run:

-    go run ./internal/cmd/gen-commands
+    make gen


We support contributors on all of our supported platforms and therefore contributing guide should work across all platforms we support IMO

Consider this a Freudian slip. Fixed.

cretz

LGTM, only two minor concerns

cretz · 2025-12-02T17:09:17Z

internal/cmd/gen-commands/main.go

I was saying they could be just commands on the existing binary (but hidden from "help"). Technically a completely different binary is fine too, but you lose the ability to easily download/version this binary.

cretz · 2025-12-02T17:09:20Z

gen-commands

Were these committed intentionally?

stephanos changed the title ~~Reusable command generator~~ Reusable commands generator Nov 18, 2025

stephanos force-pushed the reusable-codegen branch 6 times, most recently from a62ab07 to 7a4a80c Compare November 18, 2025 23:15

Reusable command generator

981a67c

stephanos force-pushed the reusable-codegen branch from 7a4a80c to 981a67c Compare November 18, 2025 23:15

use macos-15-intel

f2030e8

stephanos commented Nov 19, 2025

View reviewed changes

.github/workflows/ci.yaml

[

ubuntu-latest,

macos-latest,

macos-15-intel,

Copy link

Contributor Author

stephanos Nov 19, 2025

Choose a reason for hiding this comment

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

stephanos marked this pull request as ready for review November 19, 2025 00:20

stephanos requested review from a team as code owners November 19, 2025 00:20

stephanos requested a review from cretz November 19, 2025 00:20

move out of cliext/

8e9dc23

stephanos force-pushed the reusable-codegen branch from ca47499 to ca0942e Compare November 19, 2025 19:45

stephanos commented Nov 19, 2025

View reviewed changes

stephanos marked this pull request as draft November 19, 2025 19:59

stephanos force-pushed the reusable-codegen branch 8 times, most recently from 37c08bb to 4423bb2 Compare November 27, 2025 00:16

stephanos commented Nov 27, 2025

View reviewed changes

stephanos force-pushed the reusable-codegen branch from 4423bb2 to 4daadfb Compare November 27, 2025 00:24

stephanos force-pushed the reusable-codegen branch from 4daadfb to 04e6f13 Compare November 27, 2025 00:28

stephanos commented Nov 27, 2025

View reviewed changes

stephanos changed the title ~~Reusable commands generator~~ Commands generator binary Nov 29, 2025

stephanos force-pushed the reusable-codegen branch from 04e6f13 to f58bd71 Compare November 29, 2025 17:27

stephanos commented Nov 29, 2025

View reviewed changes

stephanos force-pushed the reusable-codegen branch from f58bd71 to 4398183 Compare November 29, 2025 17:28

stephanos commented Nov 29, 2025

View reviewed changes

re-usable types

505b732

stephanos force-pushed the reusable-codegen branch from 4398183 to 505b732 Compare November 29, 2025 17:32

stephanos marked this pull request as ready for review November 29, 2025 17:39

cretz reviewed Dec 1, 2025

View reviewed changes

stephanos added 2 commits December 2, 2025 08:37

remove make

a0fd1c0

input flag

90058fd

stephanos requested a review from cretz December 2, 2025 16:53

move to internal

3ac1c49

stephanos force-pushed the reusable-codegen branch from b2a3b4c to 3ac1c49 Compare December 2, 2025 16:59

cretz reviewed Dec 2, 2025

View reviewed changes

remove binaries

eaa17b4

cretz approved these changes Dec 2, 2025

View reviewed changes

stephanos merged commit 19449ab into temporalio:main Dec 2, 2025
8 checks passed

stephanos deleted the reusable-codegen branch December 2, 2025 19:15

Comments

Conversation

stephanos commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What was changed

Why?

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephanos Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephanos Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephanos Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephanos Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephanos Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

stephanos commented Nov 18, 2025 •

edited

Loading

stephanos Nov 19, 2025 •

edited

Loading

stephanos Nov 27, 2025 •

edited

Loading

stephanos Nov 29, 2025 •

edited

Loading

stephanos Nov 29, 2025 •

edited

Loading

cretz Dec 1, 2025 •

edited

Loading

stephanos Dec 2, 2025 •

edited

Loading