chore: add version updating script in preparation for auto-release CI #16
Conversation
jvanstraten
force-pushed
the
version-update-script
branch
from
7289cee to
03ebe2d
Compare
| template = f.read() | ||
|
|
||
| # Fill out the template. | ||
| patch = template.format(frm=current_version, to=new_version).encode("utf-8") |
There was a problem hiding this comment.
Why not use something like cargo bump instead?
There was a problem hiding this comment.
I wasn't aware of it's existence, but...
thread 'main' panicked at 'Workspaces are not supported yet.'
Also, it still wouldn't bump the version information for the Python bindings, in documentation, etc.
There was a problem hiding this comment.
Right, but that should all be handled using the tools to do such tasks for each ecosystem, or with a replacement tool such as https://github.com/google/semantic-release-replace-plugin.
For cargo bump it seems like you can handle its lack of workspace support by listing the crates and looping over them.
There was a problem hiding this comment.
I also tried from the subdirectories; it still fails. Also the issue tracking this has been stale for 3 1/2 years. In fact, all of cargo bump has been stale for 3 years. It's not exactly a standard component of cargo.
I'm perfectly fine with replacing the script with that semantic release plugin, in which case this PR can just be closed. Though to be honest it seems like a lot of complexity for what looks to be a regex replacement, which in itself seems more likely to break than a patchfile... Anyway, do you have time to help me hammer out the semantic release logic sometime, or at least to get me started with it? I remember being very confused about the logic on the main repo.
| with open("version", "r") as f: | ||
| current_version = f.read().strip() | ||
|
|
||
| if len(sys.argv) == 2 and sys.argv[1] == "get": |
There was a problem hiding this comment.
Please use argparse for all of this argument handling. It handles subcommands and will make the handling much easier to read.
There was a problem hiding this comment.
Fair enough. Was just being lazy to be honest.
| skip = True | ||
| num_changes += 1 | ||
| else: | ||
| template_lines.append(escape(line)) |
There was a problem hiding this comment.
Is all of this code doing something other than bumping the crates in the workspace?
There was a problem hiding this comment.
See https://github.com/substrait-io/substrait-validator/blob/main/RELEASE.md#incrementing-version-numbers. tl;dr, various duplicates of the version number in the various cargo.toml files, a reference in Rust's readme/docs for the customary copypasta to include a library as a dependency, and importantly pyproject.toml. It also helps update and sanity-check the patch file, which would be a massive pain otherwise.
Note that this is not exactly my idea of a clean solution, but (Python script implementation aside) I'm not sure how to do it better without making the whole thing massively more complex by special-casing everything or generating all these files.
| print() | ||
| print(f"{me} update") | ||
| print(" Interactively updates the patchfile template used to update") | ||
| print(" the version") |
There was a problem hiding this comment.
All of this can be specified using argparse.
No description provided.