morazow commented on code in PR #3447:
URL: https://github.com/apache/flink-cdc/pull/3447#discussion_r1691956059


##########
tools/mig-test/README.md:
##########
@@ -0,0 +1,36 @@
+# Flink CDC Migration Test Utilities
+
+## Pipeline Jobs
+### Preparation
+
+1. Install Ruby (macOS has embedded it by default)
+2. (Optional) Run `gem install terminal-table` for better display
+
+### Compile snapshot CDC versions
+3. Set `CDC_SOURCE_HOME` to the root directory of the Flink CDC git repository
+4. Go to `tools/mig-test` and run `ruby prepare_libs.rb` to download released 
/ compile snapshot CDC versions
+
+### Run migration tests
+5. Enter `conf/` and run `docker compose up -d` to start up test containers
+6. Set `FLINK_HOME` to the home directory of Flink
+7. Go back to `tools/mig-test` and run `ruby run_migration_test.rb` to start 
testing
+
+### Result
+The migration result will be displayed in the console like this:
+
+```
++--------------------------------------------------------------------+
+|                       Migration Test Result                        |
++--------------+-------+-------+-------+--------------+--------------+
+|              | 3.0.0 | 3.0.1 | 3.1.0 | 3.1-SNAPSHOT | 3.2-SNAPSHOT |
+| 3.0.0        | ❓    | ❓    | ❌    | ✅           | ✅           |
+| 3.0.1        |       | ❓    | ❌    | ✅           | ✅           |
+| 3.1.0        |       |       | ✅    | ❌           | ❌           |
+| 3.1-SNAPSHOT |       |       |       | ✅           | ✅           |
+| 3.2-SNAPSHOT |       |       |       |              | ✅           |
++--------------+-------+-------+-------+--------------+--------------+
+```

Review Comment:
   Could we add the meaning of `?` here?
   
   



-- 
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