Skip to content

docs: clarify how the old name behaves after renaming a flow or environment - #1322

Merged
dangrondahl merged 2 commits into
mainfrom
docs/clarify-rename-old-name-behaviour
Nov 3, 2026
Merged

dangrondahl merged 2 commits into
mainfrom
docs/clarify-rename-old-name-behaviour

Conversation

@dangrondahl

Copy link
Copy Markdown
Contributor

Summary

The long description on kosli rename flow and kosli rename environment said the old name stays accessible "until that name is taken by another flow/environment", without defining "taken" or saying whether reads and writes both still resolve.

The new text states that:

  • the old name resolves for both reads and writes: get/list return the renamed object, and attest/begin trail (or snapshot for environments) record into it rather than auto-creating a new one
  • a further rename is the only operation that requires the current name
  • "taken" means another flow/environment is created with, or renamed to, the old name, after which commands using that name act on the new object

Behaviour was confirmed by reading the server's name-history lookup and auto-create logic.

Validation

  • Ran an end-to-end check against a real org: created a flow, attested to it, renamed it, then attested again using the original name. Both attestations landed on the same trail under the new name and no flow was recreated under the old name.
  • Regenerated the reference docs with make docs and checked the rendered Markdown.
  • make lint passes.

@github-actions github-actions Bot added go Pull requests that update go code docs labels Nov 3, 2026
@claude

claude Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @dangrondahl's task in 37s —— View job


Follow-up review complete

  • Fetch previous review comments
  • Diff BEFORE..AFTER to see what changed
  • Assess status of previous findings
  • Check changed lines for new issues
  • Post summary comment

Previous finding status:

  1. Use full command names in carets instead of bare verbs (cmd/kosli/renameFlow.go) — Resolved. The new commit updates both renameFlow.go and renameEnvironment.go to use ^kosli get flow^, ^kosli list trails^, ^kosli begin trail^, ^kosli attest^, ^kosli get environment^, ^kosli list snapshots^, and ^kosli snapshot^, matching the suggested wording. I verified all referenced commands exist in cmd/kosli/ (getFlow.go, listTrails.go, beginTrail.go, attest.go, getEnvironment.go, listSnapshots.go, snapshot*.go). I've closed the original inline review thread.

New inline comments: 0 — the diff only changes doc-string text in two const declarations; no logic changed, so there's nothing new to flag.

All previously raised findings are resolved and no new issues were found.

Comment thread cmd/kosli/renameFlow.go Resolved
@dangrondahl
dangrondahl merged commit 41676d9 into main Nov 3, 2026
23 checks passed
@dangrondahl
dangrondahl deleted the docs/clarify-rename-old-name-behaviour branch November 3, 2026 07:50
dangrondahl added a commit to kosli-dev/docs that referenced this pull request Nov 3, 2026
## Summary

- Adds
`implementation_guide/phase_2/plan_organizational_structure/naming_conventions/existing_flows.md`
covering how to move flows already in use onto a naming convention:
rename rather than recreate, how the old name behaves after a rename,
rollout order, trail-name caveats, and limits.
- Adds the page to the Naming Conventions group in
`config/navigation.json`, after Flows and Trails.
- Links from the Flows and Trails page to the new page, and fixes two
relative CLI links on that page to root-relative paths.

The "how the old name behaves" section mirrors the `kosli rename flow`
long description from kosli-dev/cli#1322.

Closes #487

## Validation

- `mint broken-links`: no broken links
- `pytest tests/`: 65 passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs go Pull requests that update go code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants