Skip to content

docs: document exec + safe-default list, refresh CHANGELOG for 0.18.0#111

Merged
arimxyer merged 1 commit into
mainfrom
docs/0.18.0-release-prep
Jun 27, 2026
Merged

docs: document exec + safe-default list, refresh CHANGELOG for 0.18.0#111
arimxyer merged 1 commit into
mainfrom
docs/0.18.0-release-prep

Conversation

@arimxyer

Copy link
Copy Markdown
Collaborator

Why

Pre-release audit ahead of 0.18.0. Two user-facing changes shipped since v0.17.21 with no documentation, and the CHANGELOG had drifted (top entry was 0.17.2). This closes those gaps. No code changes — docs + context only.

What changed

File Change
docs/03-reference/command-reference.md New exec reference entry (mapping forms, -f/:field override, exit-code/read-only behavior, security note); list updated for the hidden-username default + --show-usernames + -q.
docs/02-guides/scripting-guide.md Restructured to lead with pass-cli exec as the recommended credential-injection method; old $(pass-cli get …) substitution kept as a documented fallback with a shell-tracing/CI-log leak caveat; list examples updated for the new default.
README.md exec examples in both command blocks; list examples reflect hidden-username default.
CHANGELOG.md Populated the stale [Unreleased] with everything since 0.17.2 and headed it [0.18.0].
CLAUDE.md Sync-architecture notes refreshed for the #102 marker change-detection and #103 overlapped pull.

Audit notes

  • Documented from the source (cmd/exec.go, cmd/list.go), not from the design plan — the shipped behavior is the source of truth.
  • Verified non-issues, left untouched: --offline is still a live flag and correctly documented (it was not removed by perf(sync): cut sync-related startup latency — drop dead --hash, feedback, --offline #104 — only --hash and the "Syncing… done" feedback were); the sync-guide already covers the .synchash marker.
  • <details> fallback blocks in the scripting guide render correctly (docsite/hugo.yaml sets unsafe: true).

Release follow-up

After merge: git tag v0.18.0 && git push origin v0.18.0. Version footers/dates auto-update via update-docs-version.yml on tag push.

🤖 Generated with Claude Code

Two user-facing changes shipped without docs and are now covered ahead of
the 0.18.0 release:

- exec (#98): new command reference entry, and scripting-guide rewritten to
  lead with `pass-cli exec` as the recommended way to hand a credential to a
  child command (env injection, never touches files/clipboard/history). The
  old `$(pass-cli get ...)` substitution is kept as a documented fallback with
  an explicit shell-tracing/CI-log leak caveat. README gains exec examples.
- list safe-by-default (#95, #97): documented that the table now hides the
  Username column by default, plus the new --show-usernames and -q/--quiet
  flags, across command-reference, scripting-guide, and README.

Also:
- CHANGELOG: populate the long-stale [Unreleased] (top entry was 0.17.2) with
  everything since — exec, list-safe, sync content-hash markers (#102),
  unlock-latency overlap (#103), startup-latency cleanup (#104), tracked
  mise.toml (#100), CI-on-all-PRs (#105), agent skill (#101) — and head it as
  [0.18.0].
- CLAUDE.md: refresh the Sync Architecture notes for the #102 marker-based
  change detection and the #103 overlapped pre-unlock pull.

No code changed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019sxsM218vNzDbuMZ2nhMzx
@arimxyer arimxyer merged commit 734ed53 into main Jun 27, 2026
11 checks passed
@arimxyer arimxyer deleted the docs/0.18.0-release-prep branch June 27, 2026 00:03
arimxyer added a commit that referenced this pull request Jun 27, 2026
…ndings)

The blank-check verification caught two doc bugs shipped in #111:

- CHANGELOG #104 entry was inverted (the misleading squash subject "drop dead
  --hash, feedback, --offline" drove it). Verified against the #104 diff
  (67ca1d1): it removed the dead `rclone lsjson --hash` flag, ADDED pull-side
  sync feedback (not removed; still live at cmd/helpers.go:584), and ADDED a new
  global `--offline` flag. Corrected the entry and moved `--offline` to Added.
  Also added a [0.18.0] note for the arimxyer->reyamira install-source change.
- scripting-guide.md: fixed a dead `#configuration` anchor -> the configuration
  reference doc.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019sxsM218vNzDbuMZ2nhMzx
arimxyer added a commit that referenced this pull request Jun 27, 2026
* chore(org): complete arimxyer -> reyamira repo reference sweep

The repo transferred from the `arimxyer` org to `reyamira` (the old URLs now
redirect). This rewrites every repository/web/publish reference to reyamira so
0.18.0 — the first release since the transfer — publishes to the right place.

Changed:
- .goreleaser.yml: release.github.owner + brews/scoops repository.owner ->
  reyamira; homepage/install snippets/changelog URLs -> reyamira.
- homebrew/pass-cli.rb, scoop/pass-cli.json: homepage, release download URLs,
  autoupdate/checkver -> reyamira.
- cmd/doctor.go: runtime GitHubRepo update-check slug -> reyamira/pass-cli.
- cmd/root.go, cmd/keychain_status.go, internal/config/config.go: runtime
  help/doc URL strings -> reyamira (string literals/comments only).
- README, SECURITY, CONTRIBUTING, all docs/**, docsite/hugo.yaml, issue
  templates, docs-validation workflow, winget/brew/scoop manifests,
  .doc-manager: badges, Pages URLs, repo links -> reyamira.

Deliberately kept as arimxyer (identity / module path, not repo references):
- Go module path `github.com/arimxyer/pass-cli` in go.mod + docsite/go.mod, all
  .go import statements, and the .goreleaser.yml ldflags that inject into it.
- CHANGELOG history of the prior ari1110 -> arimxyer rename.
- winget Publisher / Author / Copyright / PackageIdentifier (arimxyer.pass-cli)
  and PublisherUrl (publisher's GitHub profile).
- issue-management.yml `assignees: ['arimxyer']` (GitHub username).

Supersedes #92 (the long-open sweep, now stale). Verified: go build, go vet,
valid .goreleaser.yml, residual-grep clean (only intentional keeps remain).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019sxsM218vNzDbuMZ2nhMzx

* docs: correct #104 changelog entry and a dead anchor (verification findings)

The blank-check verification caught two doc bugs shipped in #111:

- CHANGELOG #104 entry was inverted (the misleading squash subject "drop dead
  --hash, feedback, --offline" drove it). Verified against the #104 diff
  (67ca1d1): it removed the dead `rclone lsjson --hash` flag, ADDED pull-side
  sync feedback (not removed; still live at cmd/helpers.go:584), and ADDED a new
  global `--offline` flag. Corrected the entry and moved `--offline` to Added.
  Also added a [0.18.0] note for the arimxyer->reyamira install-source change.
- scripting-guide.md: fixed a dead `#configuration` anchor -> the configuration
  reference doc.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019sxsM218vNzDbuMZ2nhMzx

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant