batches: document new version field #477
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds documentation for the new batch spec version. Relates to https://github.com/sourcegraph/sourcegraph/pull/63613
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
|
@stefanhengl content looks good. Are we ready to merge this to working branch? |
Member
Author
I am waiting for https://github.com/sourcegraph/sourcegraph/pull/63613 to merge. It shouldn't take much longer |
stefanhengl
added a commit
to sourcegraph/sourcegraph-public-snapshot
that referenced
this pull request
Jul 9, 2024
This is part of the Keyword GA Project. Batch Changes uses Sourcegraph queries to define the list of repositories on which the batch change will run. With this change we default to pattern type "keyword" instead of "standard". To make this a backward compatible change, we also introduce a version identifier to batch specs. Authors can specify `version: 2` in the spec, in which case we default to pattern type "keyword". Existing specs (without a specified version) and specs with `version: 1` will keep using pattern type "standard". Notes: - Corresponding doc update [PR](sourcegraph/docs#477) - We don't have a query input field, but instead the query is defined in a batch spec YAML. It didn't feel right to edit the YAML and append "patternType: " on save, which is what we do for Code Monitors and Insights. - I misuse the pattern type query parameter to effectively override the version. Once we introduce "V4" we should come back here and clean up. I left a TODO in the code. Test plan: - New and updated unit tests - manual testing - new batch changes use `version: 2` by default. - using an unsupported version returns an error - I ran various "on:" queries to verify that version 2 uses keyword search and version 1 uses standard search.
stefanhengl
requested review from
a team and
jtibshirani
and removed request for
jtibshirani
jtibshirani
approved these changes
Jul 9, 2024
Contributor
jtibshirani
left a comment
jtibshirani
left a comment
There was a problem hiding this comment.
Looks good to me! Left a small suggestion.
|
|
||
| ### Version 1 | ||
|
|
||
| default |
Contributor
There was a problem hiding this comment.
I find this a bit confusing, because we actually want users to consider Version 2 the default choice. Maybe we could say "The schema version before Sourcegraph version 5.5. For now, if no version is specified, batch changes will use this schema version. It is recommended to switch to version 2."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation for the new batch spec version.
Relates to https://github.com/sourcegraph/sourcegraph/pull/63613
Closes SPLF-130