Skip to content

Commit 1ce50b3

Browse files
MaedahBatoolMaedahBatool
authored
Merge branch 'main' into sg-next-jun25
2 parents 249db44 + 1dd0b1b commit 1ce50b3

File tree

24 files changed

+2458
-10147
lines changed

24 files changed

+2458
-10147
lines changed

‎docs/admin/config/batch_changes.mdx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,3 +370,42 @@ batchSpecLibrary(first: 100) {
370370
}
371371
}
372372
```
373+
374+
### Featured Templates
375+
376+
<Callout type="note">Featured templates are supported in Sourcegraph v6.4 and more.</Callout>
377+
378+
Site-admins can mark a template as featured by either clicking the star button next to the list of library records. Featured records will automatically move to a section atop the remaining library records.
379+
380+
### Labels
381+
382+
<Callout type="note">Labels are supported in Sourcegraph v6.4 and more.</Callout>
383+
384+
Batch Spec Library records support an optional `labels` field for categorization and filtering. Common labels include:
385+
386+
- `"featured"` - Marks popular or recommended batch specs that are displayed in a "Featured Templates" section above the remaining examples
387+
- Custom labels for organizational categorization (not exposed to Batch Changes users yet)
388+
389+
To remove the featured status, you can update the library record with an empty list of labels (`[]`).
390+
391+
```graphql
392+
createBatchSpecLibraryRecord(name: "example", spec: "version: 2\nname: example", labels: ["featured"]) {
393+
id
394+
labels
395+
}
396+
397+
updateBatchSpecLibraryRecord(id: "QmF0Y2hTcGVjTGlicmFyeVJlY29yZDo4", name: "example-2", spec: "version: 2\nname: example-2", labels: ["featured"]) {
398+
id
399+
labels
400+
}
401+
402+
# Query only featured batch specs
403+
batchSpecLibrary(first: 100, labels: ["featured"]) {
404+
nodes {
405+
id
406+
name
407+
labels
408+
spec
409+
}
410+
}
411+
```

‎docs/batch-changes/bulk-operations-on-changesets.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ Below is a list of supported bulk operations for changesets and the conditions w
3333
| **Commenting** | Post a comment on all selected changesets. Useful for pinging people, reminding them to take a look at the changeset, or posting your favorite emoji |
3434
| **Detach** | Detach a selection of changesets from the batch change to remove them from the archived tab |
3535
| **Re-enqueue** | Re-enqueues the pending changes for all selected changesets that failed |
36-
| **Merge (experimental)** | Merge the selected changesets on code hosts. Some changesets may be unmergeable due to their states, which does not impact the overall bulk operation. Failed merges are listed under the bulk operations tab. In the confirmation modal, you can opt for a squash merge strategy, available on GitHub, GitLab, and Bitbucket Cloud. For Bitbucket Server/Data Center, only regular merges are performed |
36+
| **Merge** | Merge the selected changesets on code hosts. Some changesets may be unmergeable due to their states, which does not impact the overall bulk operation. Failed merges are listed under the bulk operations tab. In the confirmation modal, you can opt for a squash merge strategy, available on GitHub, GitLab, and Bitbucket Cloud. For Bitbucket Server/Data Center, only regular merges are performed |
3737
| **Close** | Close the selected changesets on the code hosts |
3838
| **Publish** | Publishes the selected changesets, provided they don't have a [`published` field](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished) in the batch spec. You can choose between draft and normal changesets in the confirmation modal |
3939
| **Export** | Export selected changesets that you can use for later use |
4040
| **Re-execute** | Users can re-execute individual changeset creation logic for selected workspaces. This allows for creating new changesets for users who are using non-deterministic run steps (for example,LLMs) |
41+
| **Enable auto-merge for GitHub (experimental)** | Enable auto-merge on selected GitHub changesets. When enabled, changesets will be automatically merged once all required status checks pass and any blocking reviews are resolved. This feature is GitHub-specific and requires [appropriate setup](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository) on the target repositories. Failed actions are listed under the bulk operations tab. |
4142

4243
## Monitoring bulk operations
4344

‎docs/cli/references/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Most commands require that the user first [authenticate](quickstart#connect-to-s
1515
* [`login`](references/login)
1616
* [`lsif`](references/lsif)
1717
* [`orgs`](references/orgs)
18+
* [`prompts`](references/prompts)
1819
* [`repos`](references/repos)
1920
* [`scout`](references/scout)
2021
* [`search`](references/search)

‎docs/cli/references/prompts.mdx‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# src prompts
2+
3+
<p className="subtitle">`src prompts` is a tool that manages prompt library prompts and tags in a Sourcegraph instance.</p>
4+
5+
## Usage
6+
7+
```
8+
'src prompts' is a tool that manages prompt library prompts and tags in a Sourcegraph instance.
9+
10+
Usage:
11+
12+
src prompts command [command options]
13+
14+
The commands are:
15+
16+
list lists prompts
17+
get get a prompt by ID
18+
create create a prompt
19+
update update a prompt
20+
delete delete a prompt
21+
export export prompts to a JSON file
22+
import import prompts from a JSON file
23+
tags manage prompt tags (use "src prompts tags [command] -h" for more info)
24+
25+
Use "src prompts [command] -h" for more information about a command.
26+
```
27+
28+
## Sub-commands
29+
30+
* [list](prompts/list)
31+
* [get](prompts/get)
32+
* [create](prompts/create)
33+
* [update](prompts/update)
34+
* [delete](prompts/delete)
35+
* [export](prompts/export)
36+
* [import](prompts/import)
37+
* [tags](prompts/tags)

‎docs/cli/references/prompts/create.mdx‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# src prompts create
2+
3+
Create a new prompt in your Sourcegraph instance.
4+
5+
## Usage
6+
7+
```bash
8+
src prompts create [flags]
9+
```
10+
11+
## Examples
12+
13+
```bash
14+
# Create a basic prompt (uses current user as owner)
15+
src prompts create \
16+
-name="go-error-handling" \
17+
-description="Best practices for Go error handling" \
18+
-content="Write a Go function that properly handles errors..."
19+
20+
# Create a prompt with tags
21+
src prompts create \
22+
-name="python-optimization" \
23+
-description="Python performance optimization tips" \
24+
-content="Optimize this Python code for better performance..." \
25+
-tags="UHJvbXB0VGFnOjE=,UHJvbXB0VGFnOjI="
26+
27+
# Create a draft prompt
28+
src prompts create \
29+
-name="draft-prompt" \
30+
-description="Work in progress prompt" \
31+
-content="This prompt is still being developed..." \
32+
-draft
33+
34+
# Create a recommended prompt with auto-submit
35+
src prompts create \
36+
-name="recommended-prompt" \
37+
-description="A recommended prompt for common use" \
38+
-content="This is a recommended prompt..." \
39+
-recommended \
40+
-auto-submit
41+
42+
# Create a secret prompt for INSERT mode
43+
src prompts create \
44+
-name="secret-insert-prompt" \
45+
-description="Secret prompt for code insertion" \
46+
-content="Insert code here..." \
47+
-visibility="SECRET" \
48+
-mode="INSERT"
49+
50+
# Create a prompt with explicit owner (optional)
51+
src prompts create \
52+
-name="team-shared-prompt" \
53+
-description="A prompt shared with a specific owner" \
54+
-content="This prompt has an explicit owner..." \
55+
-owner="VXNlcjox"
56+
```
57+
58+
## Flags
59+
60+
| Flag | Description |
61+
|------|-------------|
62+
| `-name` | The prompt name (required) |
63+
| `-description` | Description of the prompt (required) |
64+
| `-content` | The prompt template text content (required) |
65+
| `-owner` | The ID of the owner (user or organization) (optional, defaults to current user) |
66+
| `-tags` | Comma-separated list of tag IDs |
67+
| `-draft` | Whether the prompt is a draft (default: false) |
68+
| `-visibility` | Visibility of the prompt: PUBLIC or SECRET (default: "PUBLIC") |
69+
| `-auto-submit` | Whether the prompt should be automatically executed in one click (default: false) |
70+
| `-mode` | Mode to execute prompt: CHAT, EDIT, or INSERT (default: "CHAT") |
71+
| `-recommended` | Whether the prompt is recommended (default: false) |
72+
73+
### API flags
74+
75+
| Flag | Description |
76+
|------|-------------|
77+
| `-dump-requests` | Log GraphQL requests and responses to stdout |
78+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) |
79+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains |
80+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing |
81+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) |

‎docs/cli/references/prompts/delete.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# src prompts delete
2+
3+
Delete a prompt from your Sourcegraph instance.
4+
5+
## Usage
6+
7+
```bash
8+
src prompts delete <prompt-id>
9+
```
10+
11+
## Examples
12+
13+
```bash
14+
# Delete a prompt by ID
15+
src prompts delete UHJvbXB0OjE=
16+
17+
# The command will confirm successful deletion
18+
src prompts delete UHJvbXB0OjE=
19+
# Output: Prompt deleted successfully.
20+
```
21+
22+
## Flags
23+
24+
### API flags
25+
26+
| Flag | Description |
27+
|------|-------------|
28+
| `-dump-requests` | Log GraphQL requests and responses to stdout |
29+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) |
30+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains |
31+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing |
32+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) |

‎docs/cli/references/prompts/export.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# src prompts export
2+
3+
Export prompts to a JSON file.
4+
5+
## Usage
6+
7+
```bash
8+
src prompts export [flags]
9+
```
10+
11+
## Examples
12+
13+
```bash
14+
# Export all prompts to stdout
15+
src prompts export
16+
17+
# Export all prompts to a file
18+
src prompts export -o prompts-backup.json
19+
20+
# Export with pretty formatting
21+
src prompts export -o prompts-backup.json -format=pretty
22+
23+
# Export prompts with specific tags
24+
src prompts export -o go-prompts.json -tags="go,golang"
25+
26+
# Export prompts with multiple tag filters
27+
src prompts export -o filtered-prompts.json -tags="python,data-science,ml"
28+
```
29+
30+
## Flags
31+
32+
| Flag | Description |
33+
|------|-------------|
34+
| `-o` | Output file path (defaults to stdout if not specified) |
35+
| `-tags` | Comma-separated list of tag names to filter by |
36+
| `-format` | JSON format: 'pretty' or 'compact' (default: 'compact') |
37+
38+
### API flags
39+
40+
| Flag | Description |
41+
|------|-------------|
42+
| `-dump-requests` | Log GraphQL requests and responses to stdout |
43+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) |
44+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains |
45+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing |
46+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) |

‎docs/cli/references/prompts/get.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# src prompts get
2+
3+
Get details about a specific prompt by ID.
4+
5+
## Usage
6+
7+
```bash
8+
src prompts get <prompt-id>
9+
```
10+
11+
## Examples
12+
13+
```bash
14+
# Get prompt by ID
15+
src prompts get UHJvbXB0OjE=
16+
```
17+
18+
## Flags
19+
20+
### API flags
21+
22+
| Flag | Description |
23+
|------|-------------|
24+
| `-dump-requests` | Log GraphQL requests and responses to stdout |
25+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) |
26+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains |
27+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing |
28+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) |

‎docs/cli/references/prompts/import.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# src prompts import
2+
3+
Import prompts from a JSON file.
4+
5+
## Usage
6+
7+
```bash
8+
src prompts import [flags]
9+
```
10+
11+
## Examples
12+
13+
```bash
14+
# Import prompts from a file (uses current user as owner)
15+
src prompts import -i prompts.json
16+
17+
# Import prompts with a specific owner
18+
src prompts import -i prompts.json -owner="VXNlcjox"
19+
20+
# Perform a dry run without creating any prompts
21+
src prompts import -i prompts.json -dry-run
22+
23+
# Skip existing prompts with the same name
24+
src prompts import -i prompts.json -skip-existing
25+
26+
# Combine flags for validation and skipping
27+
src prompts import -i prompts.json -dry-run -skip-existing
28+
```
29+
30+
## Flags
31+
32+
| Flag | Description |
33+
|------|-------------|
34+
| `-i` | Input file path (required) |
35+
| `-owner` | The ID of the owner for all imported prompts (defaults to current user) |
36+
| `-dry-run` | Validate without importing |
37+
| `-skip-existing` | Skip prompts that already exist (based on name) |
38+
39+
### API flags
40+
41+
| Flag | Description |
42+
|------|-------------|
43+
| `-dump-requests` | Log GraphQL requests and responses to stdout |
44+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) |
45+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains |
46+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing |
47+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) |

0 commit comments

Comments
 (0)