Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refresh Codemagic guide #289

Merged
merged 5 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions src/content/docs/ci/_authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
Most Shorebird functionality, like creating releases and patches, requires being 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 being
authenticated. In order to authenticate with Shorebird in CI, you will need to
generate a CI token.

```sh
shorebird login:ci
```

You will be prompted to go through a similar OAuth Flow as when using `shorebird login`, however, `shorebird login:ci` will not store any credentials on your device. Instead, a Shorebird token will be generated for you to use in CI.
You will be prompted to go through a similar OAuth Flow as when using `shorebird
login`, however, `shorebird login:ci` will not store any credentials on your
device. Instead, it will output a base-64 encoded auth token that you will use
in your CI environment.

The output should look something like:
The output of this command should look something like:

```
$ shorebird login:ci
Expand All @@ -20,13 +25,14 @@ Waiting for your authorization...

🎉 Success! Use the following token to login on a CI server:

<SHOREBIRD_TOKEN>
qwerasdf1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqwer1234asdfqw==
bryanoltman marked this conversation as resolved.
Show resolved Hide resolved

Example:

export SHOREBIRD_TOKEN="$SHOREBIRD_TOKEN" && shorebird patch android
```

:::caution
The `SHOREBIRD_TOKEN` is a secret and should not be committed directly in your source code or shared publicly.
The `SHOREBIRD_TOKEN` is a secret and should not be check in to your source
bryanoltman marked this conversation as resolved.
Show resolved Hide resolved
control or shared publicly.
:::
Loading