Skip to content

Commit d94a33e

Browse files
committed
Slight correction on handling github artifact
Ensure we allow hidden files
1 parent 58e48f1 commit d94a33e

File tree

3 files changed

+7
-7
lines changed
  • examples
    • python-sdk/context/github_action_indexer
    • typescript-sdk/context/github-action-indexer/.github/workflows

3 files changed

+7
-7
lines changed

examples/python-sdk/context/github_action_indexer/.github/workflows/index.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,5 @@ jobs:
7777
name: index-state
7878
path: .augment-index-state/
7979
retention-days: 30
80+
include-hidden-files: true
8081

examples/python-sdk/context/github_action_indexer/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ For automatic indexing of your repository on every push, copy this code into you
109109
- Add `AUGMENT_API_TOKEN` with your Augment API token
110110
- Add `AUGMENT_API_URL` with your tenant-specific URL (e.g., `https://your-tenant.api.augmentcode.com/`)
111111

112+
> **Note:** Do not include quotes around the secret values. Enter the raw values directly (e.g., `https://...` not `"https://..."`).
113+
112114
4. **Push to trigger indexing** - The workflow will run automatically on every push to `main`
113115

114116
The GitHub Actions cache will persist the index state between runs, enabling incremental updates.
@@ -119,20 +121,16 @@ After the workflow runs, you can download the index state artifact and use it fo
119121

120122
1. Go to the workflow run page (Actions tab → select the run)
121123
2. Scroll to "Artifacts" section at the bottom
122-
3. Download `index-state-{branch}` (e.g., `index-state-main`)
124+
3. Download `index-state`
123125
4. Extract and use it:
124126

125127
```bash
126128
# Navigate to the context examples directory
127129
cd examples/python-sdk/context
128130

129131
# Extract the downloaded artifact
130-
# It will contain a {branch}/ directory with state.json
131-
unzip ~/Downloads/index-state-main.zip
132-
133-
# Move it to the expected location
134-
mkdir -p .augment-index-state
135-
mv main .augment-index-state/ # or whatever branch name
132+
# It will contain a {branch}/ directory with state.json (e.g., main/state.json)
133+
unzip ~/Downloads/index-state.zip -d .augment-index-state
136134

137135
# Set your credentials
138136
export AUGMENT_API_TOKEN="your-token"

examples/typescript-sdk/context/github-action-indexer/.github/workflows/index.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,5 @@ jobs:
7777
name: index-state
7878
path: .augment-index-state/
7979
retention-days: 30
80+
include-hidden-files: true
8081

0 commit comments

Comments
 (0)