Skip to content

Commit

Permalink
Update update-a-batch-change.mdx (#894)
Browse files Browse the repository at this point in the history
Added description of what happens to manually added commits when batch
change is updated

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
  • Loading branch information
morgangauth authored Jan 14, 2025
1 parent 185b4a9 commit b23e590
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/batch-changes/update-a-batch-change.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Here are some examples:
- When the [`changesetTemplate.title`](/batch-changes/batch-spec-yaml-reference#changesettemplatetitle) or the [`changesetTemplate.body`](/batch-changes/batch-spec-yaml-reference#changesettemplatecommitauthor) are changed and the changeset has been published, the changeset on the code host will be updated accordingly
- When the [`changesetTemplate.branch`](/batch-changes/batch-spec-yaml-reference#changesettemplatetitle) is changed after the changeset has been published on the code host, the existing changeset will be closed on the code host and the new one, with the new branch, will be created
- When the batch spec is changed in such a way that no diff is produced in a repository in which the batch change has already created and published a changeset, the existing changeset will be closed on the code host and archived in the batch change
- When the changeset has been published and the batch spec is changed in such a way that a commit on the code host will be overwritten, any commits that have been manually added to the changeset on the code host will be deleted

<Callout type="note">See the [Batch Changes design](/batch-changes/design) docs for more information on the declarative nature of the Batch Changes system.</Callout>

Expand Down

0 comments on commit b23e590

Please sign in to comment.