Skip to content

Commit 46d6dbe

Browse files
fix generated command docs drift
Remove the volatile generated date from command docs so CI does not fail when the day changes, and update v0.2.0 release date references to May 5.
1 parent 44526ef commit 46d6dbe

7 files changed

Lines changed: 8 additions & 16 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ body:
1818
attributes:
1919
label: CLI version
2020
description: Output of `agora --version`
21-
placeholder: "e.g. agora-cli 0.2.0 (commit abc1234, built 2026-05-04)"
21+
placeholder: "e.g. agora-cli 0.2.0 (commit abc1234, built 2026-05-05)"
2222
validations:
2323
required: true
2424

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
When tagging a new release, rename the `[Unreleased]` section to the new version
9-
(e.g. `[0.2.0] - 2026-05-04`), add a fresh empty `[Unreleased]` heading at the top,
9+
(e.g. `[0.2.0] - 2026-05-05`), add a fresh empty `[Unreleased]` heading at the top,
1010
and update the link references at the bottom of this file.
1111

1212
When adding a new entry, link the change to the PR or commit that introduced it
@@ -15,7 +15,7 @@ Earlier entries pre-date this convention and only carry their version's compare
1515

1616
## [Unreleased]
1717

18-
## [0.2.0] - 2026-05-04
18+
## [0.2.0] - 2026-05-05
1919

2020
### Added
2121

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ change; prefer adding a new code and deprecating the old one over a rename.
164164
for user-facing changes (new commands, behavior changes, breaking changes,
165165
CLI exit code changes, error code additions). When cutting a release, move
166166
those bullets into a dated `## [x.y.z] - YYYY-MM-DD` section per the note at
167-
the top of `CHANGELOG.md` (for example, v0.2.0 shipped as `## [0.2.0] - 2026-05-04`).
167+
the top of `CHANGELOG.md` (for example, v0.2.0 shipped as `## [0.2.0] - 2026-05-05`).
168168
- For UI/UX-affecting changes (pretty output, prompts, progress events,
169169
errors), include before/after copy-paste samples in the PR description.
170170
- New commands MUST include a per-command example block in the Cobra

docs/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Command Reference
44

55
# Agora CLI — Command Reference
66

7-
> Generated from `agora introspect --json` on 2026-05-04. Do not edit by hand — run `make docs-commands` or rely on the release workflow to regenerate.
7+
> Generated from `agora introspect --json`. Do not edit by hand — run `make docs-commands` or rely on the release workflow to regenerate.
88
99
This page lists every enumerable command and its local flags. For long descriptions, examples, and inherited flags, run `agora <command> --help` or read the source in `internal/cli/`.
1010

docs/devex-backlog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,4 +154,4 @@ Update this file as items ship or priorities change.
154154
| Date | Change |
155155
| ---- | ------ |
156156
| 2026-05-01 | Initial backlog from DevEx review. |
157-
| 2026-05-04 | v0.2.0 release date in `CHANGELOG.md` set to Monday 2026-05-04. |
157+
| 2026-05-05 | v0.2.0 release date in `CHANGELOG.md` set to Tuesday 2026-05-05. |

internal/cli/docgen.go

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ import (
1313
"fmt"
1414
"io"
1515
"strings"
16-
"time"
1716

1817
"github.com/spf13/cobra"
1918
)
@@ -25,19 +24,12 @@ import (
2524
func RenderCommandReference(out io.Writer, root *cobra.Command) error {
2625
data := buildIntrospectionData(root)
2726

28-
// extractTime keeps the generated header informative without making the
29-
// timestamp diff noisy on every regen — we floor to the hour. Production
30-
// callers can always look at git history for the exact regen commit.
31-
stamp := time.Now().UTC().Format("2006-01-02")
32-
3327
var b strings.Builder
3428
b.WriteString("---\n")
3529
b.WriteString("title: Command Reference\n")
3630
b.WriteString("---\n\n")
3731
b.WriteString("# Agora CLI — Command Reference\n\n")
38-
b.WriteString("> Generated from `agora introspect --json` on ")
39-
b.WriteString(stamp)
40-
b.WriteString(". Do not edit by hand — run `make docs-commands` or rely on the release workflow to regenerate.\n\n")
32+
b.WriteString("> Generated from `agora introspect --json`. Do not edit by hand — run `make docs-commands` or rely on the release workflow to regenerate.\n\n")
4133
b.WriteString("This page lists every enumerable command and its local flags. For long descriptions, examples, and inherited flags, run `agora <command> --help` or read the source in `internal/cli/`.\n\n")
4234

4335
if version, ok := data["version"].(map[string]string); ok {

internal/cli/version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import "fmt"
77
//
88
// go build -ldflags '-X github.com/.../internal/cli.version=v0.2.0
99
// -X github.com/.../internal/cli.commit=abc1234
10-
// -X github.com/.../internal/cli.date=2026-05-04'
10+
// -X github.com/.../internal/cli.date=2026-05-05'
1111
//
1212
// Snapshot/local builds keep the placeholder values below.
1313
var (

0 commit comments

Comments
 (0)