Skip to content

Commit 833c981

Browse files
authored
feat: add weekly cn task to check documentation (#8076)
* feat: add weekly cn task to check documentation * refactor into workflow call
1 parent f4d7944 commit 833c981

File tree

4 files changed

+60
-71
lines changed

4 files changed

+60
-71
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Run Continue Agent
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
prompt:
7+
description: "The prompt to send to the Continue agent"
8+
required: true
9+
type: string
10+
agent:
11+
description: "The agent to use (e.g., continuedev/default-background-agent)"
12+
required: false
13+
type: string
14+
default: "continuedev/default-background-agent"
15+
branch_name:
16+
description: "The base branch name to work from"
17+
required: false
18+
type: string
19+
default: "main"
20+
secrets:
21+
CONTINUE_API_KEY:
22+
required: true
23+
24+
jobs:
25+
run-agent:
26+
runs-on: ubuntu-latest
27+
28+
steps:
29+
- name: Call agents endpoint
30+
run: |
31+
response=$(curl -f -X POST https://api.continue.dev/agents \
32+
-H "Content-Type: application/json" \
33+
-H "Authorization: Bearer ${{ secrets.CONTINUE_API_KEY }}" \
34+
-d '{
35+
"prompt": "${{ inputs.prompt }}",
36+
"agent": "${{ inputs.agent }}",
37+
"branchName": "${{ inputs.branch_name }}",
38+
"repoUrl": "https://github.com/${{ github.repository }}"
39+
}')
40+
id=$(echo $response | jq -r '.id')
41+
echo "https://hub.continue.dev/agents/$id"
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Weekly CN Task
2+
3+
on:
4+
schedule:
5+
# Runs at 8/9:30 AM PST (16:30 UTC) every Monday so PR shows up at beginning of week
6+
- cron: "30 16 * * 1"
7+
workflow_dispatch: # Allows manual triggering
8+
9+
jobs:
10+
run-cn-task:
11+
uses: ./.github/workflows/run-continue-agent.yml
12+
with:
13+
prompt: "Review every Markdown documentation file and verify that descriptions, examples, or behavior outlines accurately reflect the current code. Only update documentation; do not modify code. Check the corresponding code to confirm behavior before making changes. Correct any inaccuracies or outdated information in descriptions, examples, or behavior outlines. Preserve existing Markdown formatting, style, and structure. Do not add new sections, speculative explanations, or details not present in the code. Only update statements that are clearly incorrect or misleading; do not rewrite text for style or preference. Keep edits minimal and focused, ensuring that the Markdown matches what the code actually does. If verification against the code is ambiguous, leave the documentation unchanged. Use branch name bot/cleanup-<YYMMDD>-<HHMM>"
14+
agent: continuedev/default-background-agent
15+
branch_name: main
16+
secrets:
17+
CONTINUE_API_KEY: ${{ secrets.CONTINUE_API_KEY }}

core/indexing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The indexing process does the following:
2020

2121
All indexes must be returned by `getIndexesToBuild` in [`CodebaseIndexer.ts`](./CodebaseIndexer.ts) if they are to be used.
2222

23-
`CodeSnippetsIndex`: uses tree-sitter queries to get a list of functions, classes, and other top-level code objects in each file
23+
`CodeSnippetsCodebaseIndex`: uses tree-sitter queries to get a list of functions, classes, and other top-level code objects in each file
2424
`FullTextSearchCodebaseIndex`: creates a full-text search index using SQLite FTS5
2525
`ChunkCodebaseIndex`: chunks files recursively by code structure, for use in other embeddings providers like `LanceDbIndex`
2626
`LanceDbIndex`: calculates embeddings for each chunk and adds them to the LanceDB vector database, with metadata going into SQLite. Note that for each branch, a unique table is created in LanceDB.

extensions/cli/spec/shell-mode.md

Lines changed: 1 addition & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,4 @@
1-
shell Mode (CLI TUI)
2-
3-
Overview
4-
5-
- shell mode lets users run shell commands directly from the chat input by starting their input with an exclamation mark (!).
6-
- It is intended for quick terminal command execution without leaving the TUI.
7-
8-
Activation
9-
10-
- shell mode is activated when the current input (trimmed) starts with !
11-
- Example: "!git status" or " !ls -la" both activate shell mode.
12-
- Visual indicator:
13-
- Input border color changes to yellow.
14-
- The input prompt indicator changes to a yellow "$".
15-
- The input placeholder includes "! for shell mode".
16-
17-
Deactivation / Exiting shell Mode
18-
19-
- Pressing Enter to submit the input exits shell mode immediately after submission, regardless of the command result.
20-
- Pressing Esc when the input (trimmed) is exactly ! clears the input and exits shell mode.
21-
- Editing the input so it no longer starts with ! also exits shell mode and restores normal input behavior.
22-
23-
Interaction with other input helpers
24-
25-
- When in shell mode (input starts with !):
26-
- "@" file search suggestions are disabled.
27-
- "/" slash command UI is disabled.
28-
- When in slash command mode (input starts with /):
29-
- "@" file search suggestions are disabled.
30-
31-
Submission behavior
32-
33-
- On submit (Enter) with a shell-mode input:
34-
- The leading ! is removed and the remainder is treated as the shell command to run.
35-
- The TUI immediately appends an assistant message representing a shell tool call, with status set to calling, so users can see that the command is in progress.
36-
- The shell command is executed asynchronously; when it completes, the tool call status is updated to done (or error) and the output is populated.
37-
38-
Execution semantics
39-
40-
- The command is executed in the same way as terminal tool commands, minus permissions
41-
42-
Output handling
43-
44-
- Stdout is streamed into memory; Stderr is captured and appended as a trailing "Stderr: ..." section on success.
45-
- If the process exits non-zero and Stderr contains content, the tool call is marked as error and the error text is shown.
46-
- Output is truncated to the first 5000 lines if exceeded.
47-
- Timeout behavior: If no output is received for 30 seconds (configurable in tests), the process is terminated and the result includes a note like:
48-
"[Command timed out after 30 seconds of no output]".
49-
50-
Keyboard behaviors (summary)
51-
52-
- Enter: submit input. If in shell mode, exits shell mode after submission and shows the pending shell tool call immediately.
53-
- Shift+Enter: new line.
54-
- Backslash (\) at end-of-line: inserts a new line (line continuation) as usual.
55-
- Esc: if only ! (trimmed) is present, clears input and exits shell mode; otherwise cancels streaming or closes suggestions depending on context.
56-
57-
Scope / Modes
58-
59-
- shell mode applies to interactive (TUI/standard) CLI usage. It is not part of headless (-p/--print) processing.
60-
61-
Error handling
62-
63-
- Command execution errors are captured and surfaced in the tool call as status error with human-readable error text (including Stderr when available).
64-
65-
Examples
66-
67-
- "!git status" → shows a shell tool call immediately, then populates with the git status output.
68-
- "!echo hello" → shows a shell tool call immediately, then output "hello".
69-
- "!some-unknown-cmd" → shows a shell tool call immediately, then sets status to error with an error message.
70-
Shell Mode (CLI TUI)
1+
Shell Mode (CLI TUI)
712

723
Overview
734

0 commit comments

Comments
 (0)