Repository navigation
chore(cli): document FACTORY_API_KEY instead of FACTORY_TOKEN for CI auth - #71
Closed
lukealvoeiro wants to merge 1 commit into
Closed
lukealvoeiro wants to merge 1 commit into
lukealvoeiro wants to merge 1 commit into
Conversation
…auth The CLI security page told users to set FACTORY_TOKEN for CI/CD, but the CLI never reads that variable; it authenticates headless runs with FACTORY_API_KEY. Update the English page and the Japanese mirror. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Contributor
|
Droid finished @lukealvoeiro's task —— View job LGTM. The English and Japanese security pages now name the API-key environment variable used by the CLI; no actionable issues found. 0 inline comments posted |
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.
Gap
The CLI security page tells users to set the
FACTORY_TOKENenvironment variable for CI/CD. The CLI never readsFACTORY_TOKEN. The variable it uses for API-key authentication isFACTORY_API_KEY. The Japanese mirror says the same thing.Evidence
docs/cli/account/security.mdx:73:- Use the FACTORY_TOKEN environment variable for CI/CDdocs/jp/cli/account/security.mdx:73:- CI/CDではFACTORY_TOKEN環境変数を使用するFACTORY_API_KEYinapps/cli/src/environmentResolution.ts:228-231.packages/environment/src/constants/index.ts:99(FACTORY_API_KEY: 'FACTORY_API_KEY', // API key authentication).packages/runtime/auth/src/auth/source.ts:99("1. FACTORY_API_KEY env var -> api-key").rg -n FACTORY_TOKEN apps/cli/src packagesfinds only an unrelated local constantDISPLAY_FACTORY_TOKEN.HOMEand the API base blocked:FACTORY_TOKENset, the CLI sees no credential. WithFACTORY_API_KEYset, it accepts the credential and tries the network, which fails only because the API base is blocked.FACTORY_API_KEYfor CI and headless auth, for exampledocs/cli/droid-exec/overview.mdx:110anddocs/reference/cli-reference.mdx:460-468,572.Why it matters
A user who follows the security page and sets
FACTORY_TOKENin their CI secrets gets a failing pipeline with an authentication error. The page also contradicts thedroid execand CLI reference pages.Fix
In
docs/cli/account/security.mdxanddocs/jp/cli/account/security.mdx, line 73 now namesFACTORY_API_KEYinstead ofFACTORY_TOKEN. Nothing else changed. After the change,rg -n FACTORY_TOKENacross the docs repo (EN and JP) finds no matches.Validation
git diff --check: clean. 2 files changed, 2 insertions, 2 deletions.rg -n FACTORY_TOKEN .in the docs repo: no matches.Found by the scheduled CLI arguments audit (gap DOC-U1 / ROOT-U3).