Skip to content

Commit

Permalink
Refresh Codemagic guide (#289)
Browse files Browse the repository at this point in the history
* Refresh Codemagic guide

* cspell

* Update src/content/docs/ci/codemagic.mdx

Co-authored-by: Felix Angelov <[email protected]>

* Update src/content/docs/ci/_authentication.mdx

Co-authored-by: Felix Angelov <[email protected]>

---------

Co-authored-by: Felix Angelov <[email protected]>
  • Loading branch information
bryanoltman and felangel authored Sep 6, 2024
1 parent 7291907 commit 5c8a809
Show file tree
Hide file tree
Showing 2 changed files with 413 additions and 219 deletions.
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==
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 checked in to your source
control or shared publicly.
:::
Loading

0 comments on commit 5c8a809

Please sign in to comment.