Skip to content

docs: explain CLI service-account key creation for CI - #107

Open
devin-ai-integration[bot] wants to merge 29 commits into
mainfrom
devin/eng-5434-ci-api-key-docs
Open

devin-ai-integration[bot] wants to merge 29 commits into
mainfrom
devin/eng-5434-ci-api-key-docs

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Document human CLI login and service-account key creation, with --token-only | gh secret set RAVION_API_KEY so the token goes directly into the repository secret. Explain that existing API keys cannot mint new keys.

Requires CLI 1.16.8+ and the corresponding API deployment; publish after the CLI/API fix lands. Changes only the handwritten CI integration guide, not generated CLI reference pages.

Validation

  • Example flags verified against CLI help
  • pnpm exec mint broken-links
  • pnpm validate

Related: ENG-5434.

RetriggerConfidence Score: 4/5

Fix the sign-in order before merging; readers with an existing environment key can otherwise fail to finish setup.

Findings

  1. P1 Sign-in happens too early ▶
  2. P2 Token transfer can fail ▶
Fix with agent prompt
### Issue 1
config-as-code/ci-integration.mdx:34
If `RAVION_API_KEY` is already set, the CLI uses that key instead of user credentials and skips sign-in. The instruction to unset it comes after `ravion login` and `ravion switch`, so readers can reach key creation without the required user session. Move `unset RAVION_API_KEY` into the code block before `ravion login`.

### Issue 2
config-as-code/ci-integration.mdx:37-44
The new pipe creates a one-time token without first checking that GitHub can save it. If the reader has not authenticated `gh`, saving the secret can fail and lose the only copy of the token. Add a GitHub sign-in check before key creation and explain that a failed transfer may require deleting the unused key and creating another.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

Updates the CI guide with user sign-in, service-account key creation, and a direct transfer into a GitHub repository secret.

  • The CI guide shows how to create and store service-account keys.

Reviews (1) · Last reviewed commit: "Document CLI service-account API key cre..." · Reviewed by Greptile

Polylane reviews this pull request when you ask:

Review with Polylane

Link to Devin session: https://app.devin.ai/sessions/0e38e7b2054a41c1a451edab41d62e6a
Open in Devin Desktop: https://app.devin.ai/desktop/session/0e38e7b2054a41c1a451edab41d62e6a?variant=devin

Co-Authored-By: brandon <brandon@flightcontrol.dev>
@mintlify

mintlify Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Ravion 🟢 Ready View Preview Oct 16, 2026, 2:11 PM

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

Comment thread config-as-code/ci-integration.mdx Outdated
Comment thread config-as-code/ci-integration.mdx Outdated
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
…-key-docs

Co-Authored-By: brandon <brandon@flightcontrol.dev>

# Conflicts:
#	config-as-code/ci-integration.mdx
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>
Co-Authored-By: brandon <brandon@flightcontrol.dev>

This branch was successfully deployed

1 active deployment
staging — 6cb1342a Deployed Oct 16, 2026 by mintlify[bot]
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