tisonkun commented on code in PR #16: URL: https://github.com/apache/datasketches-tck/pull/16#discussion_r4180033406
########## docs/serialization-snapshots.md: ########## @@ -31,32 +31,52 @@ repository = "https://github.com/apache/datasketches-go.git"; commit = "730c0ca31e00b8becf8b70591ae8ca73954912d0" ``` -## Update to the latest snapshots +## Update snapshots -With the [toolchain installed](#set-up-the-toolchain), use `HEAD` to update each source to its default branch: +With the [toolchain installed](#set-up-the-toolchain), update every available source to its remote default branch: ```shell -mise run tck -- snapshots update cpp HEAD -mise run tck -- snapshots update go HEAD -mise run tck -- snapshots update java HEAD +mise run tck -- snapshots update ``` -For each source, the command resolves the default branch to an exact commit ID, writes it to `config.toml`, and regenerates `serialization_test_data/<language>_generated_files`. Generation happens before either file set is changed, so a source whose generation fails is left untouched. +Update is the only command that writes snapshots. It accepts an optional language and, after that, an optional revision: -When a source's commit has not changed and only probabilistic snapshots differ, its snapshots are left as they are, so repeated updates do not add binary churn to the history. +| Command | Sources and revisions | +|------------------------------|------------------------------------------------------------| +| `snapshots update` | All available languages at their remote `HEAD` | +| `snapshots update go` | Go at its remote `HEAD` | +| `snapshots update go HEAD` | The same explicit selection | +| `snapshots update go v0.2.0` | Go at the specified tag; branches and commit IDs also work | Review Comment: fyi @leerho @freakyzoidberg I changed the CLI facade a bit. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
