[
https://issues.apache.org/jira/browse/IGNITE-29261?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Aleksandr Chesnokov updated IGNITE-29261:
-----------------------------------------
Description:
Generate and compare wire format JSON in CI so contributors can stop committing
the generated files. CI compares the target branch snapshot with GitHub's test
merge of the PR. It shows changes to the format and message IDs in Job Summary
and warns the reviewer. A build or comparison error fails the check. This works
for target branches with the required generators. IGNITE-29145 covers the label
and bot comment.
Before merging this change, check whether any open PRs add generated files
under {{modules/wire-compatibility-check/wire/}}. Remove those files from the
affected PRs so a later merge cannot put them back in Git.
See the [review
spec|https://issues.apache.org/jira/secure/attachment/13086457/IGNITE-29261-review-spec.md]
for the build command, expected results and review cases.
was:
Let's remove generated wire format JSON files from Git so contributors no
longer need to update and commit them. As part of the normal PR checks, CI
should generate the descriptions, including message IDs, for the target branch
and the result of a test merge of the PR, then show their diff in GitHub
Actions Job Summary. This should work for any target branch that has the
required generators. Format changes should produce a warning for review, while
build or comparison errors should fail the check. Updating the compatibility
label through workflow_run is a separate task.
Before merging, check open PRs for generated JSON added under
{{modules/wire-compatibility-check/wire/}}. Remove those files from the
affected PRs before they merge.
See the [review
spec|https://issues.apache.org/jira/secure/attachment/13086453/IGNITE-29261-spec.md]
for the build, report and acceptance details.
> Generate and compare wire format descriptions in CI instead of tracking them
> in Git
> -----------------------------------------------------------------------------------
>
> Key: IGNITE-29261
> URL: https://issues.apache.org/jira/browse/IGNITE-29261
> Project: Ignite
> Issue Type: Improvement
> Reporter: Aleksandr Chesnokov
> Assignee: Aleksandr Chesnokov
> Priority: Major
> Fix For: 2.20
>
> Attachments: IGNITE-29261-review-spec.md, IGNITE-29261-spec.md
>
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Generate and compare wire format JSON in CI so contributors can stop
> committing the generated files. CI compares the target branch snapshot with
> GitHub's test merge of the PR. It shows changes to the format and message IDs
> in Job Summary and warns the reviewer. A build or comparison error fails the
> check. This works for target branches with the required generators.
> IGNITE-29145 covers the label and bot comment.
> Before merging this change, check whether any open PRs add generated files
> under {{modules/wire-compatibility-check/wire/}}. Remove those files from the
> affected PRs so a later merge cannot put them back in Git.
> See the [review
> spec|https://issues.apache.org/jira/secure/attachment/13086457/IGNITE-29261-review-spec.md]
> for the build command, expected results and review cases.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
