-
Notifications
You must be signed in to change notification settings - Fork 10
Improve examples #48
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
Merged
Merged
Improve examples #48
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,15 +65,36 @@ The installation script will: | |
|
|
||
| ### 2. Configure Repository Secrets | ||
|
|
||
| Add these secrets to your repository (Settings → Secrets and variables → Actions): | ||
| In the GitHub UI, navigate to your repository **Settings → Secrets and variables → Actions** and add these secrets: | ||
|
|
||
| | Secret Name | Description | Required | | ||
| |-------------|-------------|----------| | ||
| | `AUGMENT_API_TOKEN` | Your Augment API token (can be a JSON object with `accessToken` and `tenantURL` fields, or a plain token string) | Yes | | ||
| | `AUGMENT_API_TOKEN` | Your Augment API token | Yes | | ||
| | `AUGMENT_API_URL` | Your tenant-specific Augment API URL (e.g., `https://your-tenant.api.augmentcode.com/`) | Yes | | ||
|
|
||
| **How to get your credentials:** | ||
|
|
||
| 1. **Using the Auggie CLI** (recommended): | ||
| ```bash | ||
| # Login to Augment | ||
| auggie login | ||
|
|
||
| # Print your credentials | ||
| auggie token print | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Docs/changelog refer to 🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage. |
||
| ``` | ||
|
|
||
| This outputs: | ||
| ``` | ||
| TOKEN={"accessToken":"your-token-here","tenantURL":"https://your-tenant.api.augmentcode.com/","scopes":["read","write"]} | ||
| ``` | ||
|
|
||
| Extract the values from the JSON: | ||
| - `accessToken` → use for `AUGMENT_API_TOKEN` | ||
| - `tenantURL` → use for `AUGMENT_API_URL` | ||
|
|
||
| 2. **From your Augment account**: Contact your Augment administrator or check your account settings for API credentials. | ||
|
|
||
| **Note:** | ||
| - If using a plain token string, you must also set `AUGMENT_API_URL` as a secret or environment variable | ||
| - If your token is a JSON object from `~/.augment/session.json` (with `accessToken` and `tenantURL`), the URL will be extracted automatically | ||
| - `GITHUB_TOKEN`, `GITHUB_REPOSITORY`, and `GITHUB_SHA` are automatically provided by GitHub Actions | ||
|
|
||
| ### 3. Push and Run | ||
|
|
||
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that the indexer requires
AUGMENT_API_URL, the bundled example workflow atexamples/typescript-sdk/context/github-action-indexer/.github/workflows/index.ymlwill likely need to passAUGMENT_API_URLtoo (it currently only setsAUGMENT_API_TOKEN). Otherwise users copying that workflow could hit a missing-env error.Fix This in Augment
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.