Merge pull request #574 from input-output-hk/djo/543/ci-add-commit-hash-to-toml

Add commit hash to toml before build in CI

Author: Alenar

.github/workflows/actions/build-upload-mithril-artifact/action.yml

@@ -23,6 +23,12 @@ runs:
       uses: Swatinem/rust-cache@v2
       with:
         key: ${{ runner.os }}-cache-v${{ inputs.cache-version }}
+        
+    - name: Add commit short sha to Cargo.tomls version
+      shell: bash
+      run: |
+        pip3 install toml
+        python3 ./.github/workflows/scripts/edit-cargo-toml-version.py -l $(echo ${{ github.sha }} | cut -c1-7)
 
     - name: Cargo build
       uses: actions-rs/cargo@v1

.github/workflows/scripts/edit-cargo-toml-version.py

@@ -0,0 +1,55 @@
+import argparse
+import glob
+import os
+
+import toml
+
+
+def dir_path(path):
+    if os.path.isdir(path):
+        return path
+    else:
+        raise NotADirectoryError(path)
+
+
+def append_label_to_cargo_toml_version(cargo_toml_path, label: str, dry_run: bool):
+    cargo_toml = toml.load(cargo_toml_path)
+    print(f"Editing {cargo_toml_path} ...")
+
+    if 'package' not in cargo_toml:
+        print("No package section (probably a workspace file), skipping this Cargo.toml")
+        return
+
+    new_version = f"{cargo_toml['package']['version'].split('-', 1)[0]}-{label}"
+    print(f"{cargo_toml_path} new version: {new_version}")
+
+    if not dry_run:
+        cargo_toml['package']['version'] = new_version
+
+        with open(cargo_toml_path, "w") as f:
+            toml.dump(cargo_toml, f)
+
+
+def main(args):
+    workdir = os.path.relpath(args.working_dir)
+    print(f"Searching for Cargo.toml(s) in '{workdir}' to edit their version label ...")
+
+    cargo_tomls = glob.glob(f"{workdir}/**/Cargo.toml", recursive=True)
+    print(f"Cargo.toml(s) found: {cargo_tomls}")
+
+    for cargo_toml in cargo_tomls:
+        append_label_to_cargo_toml_version(cargo_toml, args.semver_label, args.dry_run)
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        prog="Cargo.toml semver label editor",
+        description="Edit all Cargo.toml in the given path and subdirectories by replacing their label with the given"
+                    " '--semver-label'.")
+    parser.add_argument("-l", "--semver-label", required=True,
+                        help="Label to suffix to the Cargo.toml(s) semver version")
+    parser.add_argument("-d", "--working-dir", type=dir_path, default="./",
+                        help="Directory in which Cargo.toml will be searched")
+    parser.add_argument("--dry-run", action="store_true")
+
+    main(parser.parse_args())

.github/workflows/scripts/package-distribution.py

@@ -31,8 +31,8 @@ def dir_path(path):
 
 
 def build_archive(input_dir, destination_dir, archive_basename):
-    input_files = os.listdir(args.input)
-    print(f"packing mithril distribution {args.version}-{args.target} with files: {input_files}")
+    input_files = os.listdir(input_dir)
+    print(f"packing {archive_basename} with files: {input_files}")
 
     if platform.system() == "Windows":
         import zipfile
@@ -53,10 +53,10 @@ def build_archive(input_dir, destination_dir, archive_basename):
     return archive_name
 
 
-def check_archive(archive, original_input_dir):
+def check_archive(archive_path, original_input_dir):
     print(f"checking archive ...")
     test_dir = "./unpack-test"
-    shutil.unpack_archive(archive, test_dir)
+    shutil.unpack_archive(archive_path, test_dir)
     original_checksum = sha256sum(original_input_dir)
     archive_content_checksum = sha256sum(test_dir)
     if original_checksum != archive_content_checksum:
@@ -69,23 +69,30 @@ def check_archive(archive, original_input_dir):
     shutil.rmtree(test_dir)
 
 
-def compute_sha256_checksum(archive):
+def compute_sha256_checksum(archive_path):
     print(f"computing archive checksum...")
-    archive_checksum = sha256sum(archive)
-    checksum_filename = f"{archive}.sha256"
+    archive_checksum = sha256sum(archive_path)
+    checksum_filename = f"{archive_path}.sha256"
     with open(checksum_filename, "x") as f:
         f.write(archive_checksum)
 
 
+def main(args):
+    archive_path = build_archive(args.input, args.dest, archive_basename=f"mithril-{args.version}-{args.target}")
+    check_archive(archive_path, args.input)
+    compute_sha256_checksum(archive_path)
+
+
 if __name__ == '__main__':
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        prog="Mithril distribution packager",
+        description="Package the files in the given '--input' dir in a .tar.gz (linux, macOs) or .zip (windows)"
+                    " plus add a file with the value the sha256 of the generated package."
+    )
     parser.add_argument("--input", type=dir_path, help="input folder which content will be archived", required=True)
     parser.add_argument("--dest", type=dir_path, help="destination folder for the archive, default to current folder",
                         default="./")
     parser.add_argument("--version", help="version of the distribution to package", required=True)
     parser.add_argument("--target", help="target os & architecture of the package", required=True)
-    args = parser.parse_args()
 
-    archive_path = build_archive(args.input, args.dest, archive_basename=f"mithril-{args.version}-{args.target}")
-    check_archive(archive_path, args.input)
-    compute_sha256_checksum(archive_path)
+    main(parser.parse_args())