docs: keep product profile examples generic - #78
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the public product guidance and test/fixture references to use a neutral automation profile name instead of an internal example, keeping the CLI behavior unchanged.
Changes:
- Replaced
devs-fe-autowithautomationacross unit tests and CLI command-path tests. - Updated consumer-facing docs (README + skills references) to recommend
automationfor non-human sessions. - Updated smoke packed-install fixture config and assertions to use the
automationprofile name.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/internal/state.test.ts | Updates persisted-auth/profile test fixtures and expectations to use automation. |
| src/internal/config.test.ts | Updates env-driven config test to use PUTIO_CLI_PROFILE=automation. |
| src/command-paths.test.ts | Updates CLI command-path tests that pass/expect the profile name. |
| src/cli.test.ts | Updates argv parsing tests for auth profiles use/remove to use automation. |
| skills/putio-cli/SKILL.md | Updates skill guidance and examples to recommend automation as the named profile. |
| skills/putio-cli/references/auth.md | Updates auth reference examples/env var guidance to use automation. |
| scripts/smoke-packed-install.mts | Updates packed smoke fixture config + command expectations for the new profile name. |
| README.md | Updates public setup instructions and rules to use automation. |
Suppressed comments (2)
scripts/smoke-packed-install.mts:301
- This failure message refers to a "dev profile" but the script is now specifically persisting the
automationprofile as default. Aligning the message with the actual profile name makes smoke failures easier to diagnose.
assert(
selectedList.defaultProfile === "automation",
"Expected `profiles use` to persist dev profile as default.",
scripts/smoke-packed-install.mts:305
- This failure message still says "dev profile" while the code is asserting the
automationprofile is current. Updating the message keeps the assertion output consistent with the scenario.
assert(
selectedList.profiles.find((profile) => profile.name === "automation")?.current === true,
"Expected dev profile to be current after `profiles use`.",
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
|
🎉 This PR is included in version 1.7.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The public product guidance and test fixtures used an internal frontend automation profile as their canonical example. Replace it with the neutral
automationprofile throughout the current tree without changing behavior.Verification
pnpm exec vp run verifyNotes
No runtime behavior changes.