snuyanzin commented on code in PR #29240:
URL: https://github.com/apache/flink/pull/29240#discussion_r4053772478


##########
flink-table/flink-table-planner/AGENTS.md:
##########
@@ -78,7 +79,7 @@ Some existing rules still use Calcite's older `RelOptRule`; 
prefer `RelRule` for
 
 Then:
 1. Register in `FlinkStreamRuleSets.scala` and/or `FlinkBatchRuleSets.scala`
-2. Plan tests with XML golden files — when the test fails, copy the 
framework's generated log file over the reference `.xml` (cases are ordered 
alphabetically by method name)
+2. Plan tests with XML golden files. When a test fails, copy the generated 
`<Class>_actual.xml` over the reference `.xml` (cases are ordered 
alphabetically by method name). A case missing from the reference also fails 
and the current plan is written to that file, or straight into the reference 
when it is empty. For a bug fix, write the expected case by hand, or the golden 
records the bug. `explain/**/*.out` files are plain string goldens; 
`ExplainTest` regenerates its own under `PLAN_TEST_FORCE_OVERWRITE`, the others 
are edited by hand.

Review Comment:
   about xml sounds like super complicated approach...
   after FLINK-38609
   the approach for `xml`
   1. drop `xml`
   2. run all the tests from the specific class (it will fail however it will 
create a renewed `xml`)
   3. run again to double check it is green now
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to