You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -102,7 +102,7 @@ The following template variables are available in the fields under `changesetTem
102
102
| `steps.added_files` | `list of strings` | List of files that have been added by the `steps`. Empty list if no files have been added |
103
103
| `steps.deleted_files` | `list of strings` | List of files deleted by the `steps`. Empty list if no files have been deleted |
104
104
| `steps.path` | `string` | Path (relative to the root of the directory, no leading `/` or `.`) in which the `steps` have been executed. Empty if no workspaces have been used and the `steps` were executed in the root of the repository |
105
-
| `outputs.<name>` | depends on `outputs.<name>.format`, default: `string`| Value of an [`output`](/batch-changes/batch-spec-yaml-reference#steps-outputs) set by `steps`. If the [`outputs.<name>.format`](batch_spec_yaml_reference#steps-outputs-format) is `yaml` or `json` and the `value` a data structure (i.e., array, object, ...), then subfields can be accessed too. See [Templating Examples](#templating-examples) below |
105
+
| `outputs.<name>` | depends on `outputs.<name>.format`, default: `string`| Value of an [`output`](batch-spec-yaml-reference#stepsoutputs) set by `steps`. If the [`outputs.<name>.format`](batch-spec-yaml-reference#stepsoutputsnameformat) is `yaml` or `json` and the `value` a data structure (i.e., array, object, ...), then subfields can be accessed too. See [Templating Examples](#templating-examples) below |
106
106
| `batch_change_link` | `string` | <strong><small>Only available in `changesetTemplate.body`</small></strong><br />Link back to the batch change that produced the changeset on Sourcegraph. If omitted, the link will be automatically appended to the end of the body. <br />Requires [Sourcegraph CLI](/cli/) 3.40.9 or later |
107
107
108
108
## Template helper functions
@@ -212,7 +212,7 @@ changesetTemplate:
212
212
The second step left this one: ${{ outputs.otherMessage }}
213
213
```
214
214
215
-
Using the [`steps.outputs.<name>.format`](/batch-changes/batch-spec-yaml-reference#steps-outputs-name-format) field, it's possible to parse the value of output as JSON or YAML and access it as a data structure instead of just text:
215
+
Using the [`steps.outputs.<name>.format`](/batch-changes/batch-spec-yaml-reference#stepsoutputsnameformat) field, it's possible to parse the value of output as JSON or YAML and access it as a data structure instead of just text:
216
216
217
217
```yaml
218
218
steps:
@@ -244,7 +244,7 @@ changesetTemplate:
244
244
${{ end }}
245
245
```
246
246
247
-
Using the [`steps.if`](/batch-changes/batch-spec-yaml-reference#steps-if) field to conditionally execute different steps in different repositories:
247
+
Using the [`steps.if`](/batch-changes/batch-spec-yaml-reference#stepsif) field to conditionally execute different steps in different repositories:
Copy file name to clipboardExpand all lines: docs/batch-changes/bulk-operations-on-changesets.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Below is a list of supported bulk operations for changesets and the conditions w
35
35
|**Re-enqueue**| Re-enqueues the pending changes for all selected changesets that failed |
36
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 |
37
37
|**Close**| Close the selected changesets on the code hosts |
38
-
|**Publish**| Publishes the selected changesets, provided they don't have a [`published` field](/batch-changes/batch-spec-yaml-reference#changesettemplate-published) in the batch spec. You can choose between draft and normal changesets in the confirmation modal |
38
+
|**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 |
39
39
|**Export**| Export selected changesets that you can use for later use |
Copy file name to clipboardExpand all lines: docs/batch-changes/create-a-batch-change.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ changesetTemplate:
49
49
published: false # Do not publish any changes to the code hosts yet
50
50
```
51
51
52
-
The commits created from your spec will use the `git config` values for `user.name` and `user.email` from your local environment or `[email protected]` if no user is set. Alternatively, you can also [specify an `author`](/batch-changes/batch-spec-yaml-reference#changesettemplate-commit-author) in this spec.
52
+
The commits created from your spec will use the `git config` values for `user.name` and `user.email` from your local environment or `[email protected]` if no user is set. Alternatively, you can also [specify an `author`](/batch-changes/batch-spec-yaml-reference#changesettemplatecommitauthor) in this spec.
53
53
54
54
<Callout type="info">See the [batch spec YAML reference](/batch-changes/batch-spec-yaml-reference) for more details on how to write batch specs.</Callout>
Copy file name to clipboardExpand all lines: docs/batch-changes/faq.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ There's a rule of thumb:
60
60
## Can I create tickets or issues along with Batch Changes?
61
61
62
62
Batch Changes does not support a declarative syntax for issues or tickets.
63
-
However, [steps](/batch-changes/batch-spec-yaml-reference#steps-run) can run any container. Some users have built scripts to create tickets for each apply:
63
+
However, [steps](/batch-changes/batch-spec-yaml-reference#stepsrun) can run any container. Some users have built scripts to create tickets for each apply:
@@ -84,7 +84,7 @@ Unapplied batch specs are removed from the database after **seven days**.
84
84
85
85
Yes. When [executing a batch spec](/batch-changes/how-src-executes-a-batch-spec), `src` will attempt to pull missing docker images. If you are logged into the private container registry, it will pull from it.
86
86
87
-
Also, see [`steps.container`](/batch-changes/batch-spec-yaml-reference#steps-container). Within the spec, it will work as expected if `docker pulls` points to your private registry from the command line.
87
+
Also, see [`steps.container`](/batch-changes/batch-spec-yaml-reference#stepscontainer). Within the spec, it will work as expected if `docker pulls` points to your private registry from the command line.
88
88
89
89
However, outside the spec, `src` pulls an image from Docker Hub when running in volume workspace mode. This is the default on macOS, so you will need to use one of the following three workarounds:
90
90
@@ -136,14 +136,14 @@ Remember the context in which the inner `${{ }}` will be evaluated, and be sure
136
136
137
137
## How is commit author determined for commits produced from Batch Changes?
138
138
139
-
Commit author is determined when running `src batch [apply|preview]`. If no [author](/batch-changes/batch-spec-yaml-reference#changesettemplate-commit-author) key is defined in the batch spec, `src` will try to use the git config values for `user.name` and `user.email` from your local environment, or `[email protected]` if no user is set.
139
+
Commit author is determined when running `src batch [apply|preview]`. If no [author](/batch-changes/batch-spec-yaml-reference#changesettemplatecommitauthor) key is defined in the batch spec, `src` will try to use the git config values for `user.name` and `user.email` from your local environment, or `[email protected]` if no user is set.
140
140
141
141
## Why is the checkbox on my changeset disabled when previewing a batch change?
142
142
143
143
Since Sourcegraph 3.31, it is possible to publish many types of changesets when previewing a batch change by modifying the publication state for the changeset directly from the UI (see ["Publishing changesets"](/batch-changes/publishing-changesets#from-the-preview)). However, not every changeset can be published by Sourcegraph. By hovering over your changeset's disabled checkbox, you can see why that specific changeset is not currently publishable. The most common reasons include:
144
144
145
145
- The changeset is already published (we cannot unpublish a changeset or convert it back to a draft)
146
-
- The changeset's publication state is being controlled from your batch spec file (i.e., you have the [`published` flag set in your batch spec](/batch-changes/batch-spec-yaml-reference#changesettemplate-published)); the batch spec takes precedence over the UI
146
+
- The changeset's publication state is being controlled from your batch spec file (i.e., you have the [`published` flag set in your batch spec](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished)); the batch spec takes precedence over the UI
147
147
- You do not have permission to publish to the repository the changeset would be opened against
148
148
- The changeset was imported (and was therefore already published by someone or something else)
Copy file name to clipboardExpand all lines: docs/batch-changes/publishing-changesets.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ changesetTemplate:
109
109
Then run the `src batch preview` command again or `src batch apply` to publish the changesets immediately. Publishing a changeset will:
110
110
111
111
- Create a commit with the changes from the patches for that repository
112
-
- Push a branch using the branch name you defined in the batch spec with [`changesetTemplate.branch`](/batch-changes/batch-spec-yaml-reference#changesettemplate-branch). If [forks are enabled](/admin/config/batch_changes#forks), then the branch will be pushed to a fork of the repository
112
+
- Push a branch using the branch name you defined in the batch spec with [`changesetTemplate.branch`](/batch-changes/batch-spec-yaml-reference#changesettemplatebranch). If [forks are enabled](/admin/config/batch_changes#forks), then the branch will be pushed to a fork of the repository
113
113
- Create a changeset (e.g., GitHub pull request) on the code host for review and merging
114
114
115
115
<Callout type="note">When pushing the branch Sourcegraph will use a **force push**. Make sure that the branch names are unused otherwise, previous commits will be overwritten.</Callout>
@@ -135,7 +135,7 @@ changesetTemplate:
135
135
- github.com/sourcegraph-private/*: false
136
136
```
137
137
138
-
<Callout type="info">See [`changesetTemplate.published`](/batch-changes/batch-spec-yaml-reference#changesettemplate-published) in the batch spec reference for more details.</Callout>
138
+
<Callout type="info">See [`changesetTemplate.published`](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished) in the batch spec reference for more details.</Callout>
139
139
140
140
### Publishing changesets as drafts
141
141
@@ -149,13 +149,13 @@ changesetTemplate:
149
149
published: draft
150
150
```
151
151
152
-
<Callout type="info">See [`changesetTemplate.published`](/batch-changes/batch-spec-yaml-reference#changesettemplate-published) in the batch spec reference for more details.</Callout>
152
+
<Callout type="info">See [`changesetTemplate.published`](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished) in the batch spec reference for more details.</Callout>
153
153
154
154
### Fully publishing draft changesets
155
155
156
156
If you have previously published changesets as drafts on code hosts by setting `published` to `draft`, you then fully publish them and take them out of draft mode by updating the `published` to `true`.
157
157
158
-
<Callout type="info">See [`changesetTemplate.published`](/batch-changes/batch-spec-yaml-reference#changesettemplate-published) in the batch spec reference for more details.</Callout>
158
+
<Callout type="info">See [`changesetTemplate.published`](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished) in the batch spec reference for more details.</Callout>
159
159
160
160
## Within the UI
161
161
@@ -193,4 +193,4 @@ Once applied, you can select the changesets you want to publish from the batch c
193
193
194
194
Regardless of how you publish your changesets, the commit created and pushed to the branch uses the details specified in the batch spec's `changesetTemplate` field.
195
195
196
-
<Callout type="info">See [`changesetTemplate.commit`](/batch-changes/batch-spec-yaml-reference#changesettemplate-commit) for details on how to set the author and the commit message.</Callout>
196
+
<Callout type="info">See [`changesetTemplate.commit`](/batch-changes/batch-spec-yaml-reference#changesettemplatecommit) for details on how to set the author and the commit message.</Callout>
Copy file name to clipboardExpand all lines: docs/batch-changes/quickstart.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,7 +66,7 @@ changesetTemplate:
66
66
message: Append Hello World to all README files
67
67
```
68
68
69
-
The commits you create here will use the `git config` values for `user.name` and `user.email` from your local environment or `[email protected]` if no user is set. Alternatively, you can also [specify an `author`](/batch-changes/batch-spec-yaml-reference#changesettemplate-commit-author) in this spec.
69
+
The commits you create here will use the `git config` values for `user.name` and `user.email` from your local environment or `[email protected]` if no user is set. Alternatively, you can also [specify an `author`](/batch-changes/batch-spec-yaml-reference#changesettemplatecommitauthor) in this spec.
Copy file name to clipboardExpand all lines: docs/batch-changes/reexecuting-batch-specs-multiple-times.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ In practical terms, a user should be able to run `src batch apply -f my.batch.ya
14
14
15
15
That can only work if the inputs to the batch spec stay the same, too.
16
16
17
-
Since a batch spec's [`on.repositoriesMatchingQuery`](/batch-changes/batch-spec-yaml-reference#on-repositoriesmatchingquery) uses Sourcegraph's search functionality to **dynamically** produce a list of repositories in which to execute the [`steps`](/batch-changes/batch-spec-yaml-reference#steps), the list of repositories might change between executions of `src batch apply`.
17
+
Since a batch spec's [`on.repositoriesMatchingQuery`](/batch-changes/batch-spec-yaml-reference#onrepositoriesmatchingquery) uses Sourcegraph's search functionality to **dynamically** produce a list of repositories in which to execute the [`steps`](/batch-changes/batch-spec-yaml-reference#steps), the list of repositories might change between executions of `src batch apply`.
18
18
19
19
If that's the case, the `steps` need to be re-executed in any newly found repositories. Changesets in repositories that are not found anymore will be closed and archived in the batch change (see [Updating a batch change](/batch-changes/update-a-batch-change) for more details). In unchanged repositories, [Sourcegraph CLI](/cli/) tries to use cached results to avoid re-executing the `steps`.
20
20
@@ -25,8 +25,8 @@ Whenever [Sourcegraph CLI](/cli/) re-executes the same batch spec, it checks a *
25
25
Whether a cached result can be used is dependent on multiple things:
26
26
27
27
- The repository's default branch's revision didn't change (because if new commits have been pushed to the repository, re-executing the `steps` might lead to different results)
28
-
- The `steps` themselves didn't change, including all their inputs, such as [`steps.env`](/batch-changes/batch-spec-yaml-reference#environment-array), and the `steps.run` field (which can change between executions if it uses [templating](/batch-changes/batch-spec-templating) and is dynamically built from search results)
28
+
- The `steps` themselves didn't change, including all their inputs, such as [`steps.env`](/batch-changes/batch-spec-yaml-reference#environmentarray), and the `steps.run` field (which can change between executions if it uses [templating](/batch-changes/batch-spec-templating) and is dynamically built from search results)
29
29
30
30
That also means that [Sourcegraph CLI](/cli/) can use cached results when re-executing a **changed batch spec**, as long as the changes didn't affect the `steps` and the results they produce.
31
31
32
-
For example, if only the [`changesetTemplate.title`](/batch-changes/batch-spec-yaml-reference#changesettemplate-title) field has been changed, cached results can be used, since that field doesn't have any influence on the `steps` and their results.
32
+
For example, if only the [`changesetTemplate.title`](/batch-changes/batch-spec-yaml-reference#changesettemplatetitle) field has been changed, cached results can be used, since that field doesn't have any influence on the `steps` and their results.
0 commit comments