feat: Update documentation surrounding CI and API keys#516
Open
feat: Update documentation surrounding CI and API keys#516
Conversation
eseidel
reviewed
Mar 23, 2026
| ## Migrating from `shorebird login:ci` | ||
|
|
||
| The `shorebird login:ci` command is deprecated. Existing tokens generated by | ||
| `login:ci` will continue to work until March 2027, but we recommend replacing |
Contributor
There was a problem hiding this comment.
Suggested change
| `login:ci` will continue to work until March 2027, but we recommend replacing | |
| `login:ci` will continue to work until September 2026, but we recommend replacing |
Contributor
There was a problem hiding this comment.
Yeah I agree on the 6 months timeline. Biggest thing is making sure we end up putting this into multiple customer comms like the newsletter and other emails
cc @dawn-ducky
eseidel
reviewed
Mar 23, 2026
| The `SHOREBIRD_TOKEN` is a secret and should not be checked in to your source | ||
| control or shared publicly. | ||
| The `shorebird login:ci` command is deprecated. Existing tokens generated by | ||
| `login:ci` will continue to work until March 2027, but new tokens should be |
Contributor
There was a problem hiding this comment.
Suggested change
| `login:ci` will continue to work until March 2027, but new tokens should be | |
| `login:ci` will continue to work until September 2026, but new tokens should be |
tomarra
reviewed
Mar 24, 2026
| authenticated. In order to authenticate with Shorebird in CI, you will need to | ||
| generate a CI token. | ||
| Most Shorebird functionality, like creating releases and patches, requires | ||
| authentication. To authenticate in CI, create an API key from the |
Contributor
There was a problem hiding this comment.
Suggested change
| authentication. To authenticate in CI, create an API key from the | |
| authentication. To authenticate in your CI, create an API key from the |
We kind of need to start talking about a users CI system vs. ours since we have a CI product as well.
tomarra
reviewed
Mar 24, 2026
| ::: | ||
|
|
||
| Example: | ||
| :::note |
Contributor
There was a problem hiding this comment.
Feels kinda weird to have 3 callouts in a row.
tomarra
reviewed
Mar 24, 2026
|
|
||
| export SHOREBIRD_TOKEN="$SHOREBIRD_TOKEN" && shorebird patch android | ||
| ``` | ||
| On Pro and Business plans, you can restrict an API key to **Release & Patch |
Contributor
There was a problem hiding this comment.
Should this just link to the orgs section that talks about roles instead of duplicating the content?
tomarra
reviewed
Mar 24, 2026
| - **Full access** — the key has the same permissions as your account. Available | ||
| on all plans. | ||
| - **Release & Patch only** — the key can create releases and patches, but cannot | ||
| manage apps, organizations, members, or billing. Available on Pro and Business |
Contributor
There was a problem hiding this comment.
Same thing with a link to the orgs/roles section would be good here.
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
3 participants
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.
Status
READY
Description
login:ci, and security details.shorebird login:cicommand. Includes a migration callout notinglogin:citokens remain valid until March 2027.