Get old Artifacts.toml from deploy branch

make_artifacts.jl

@@ -19,8 +19,11 @@ const datasets_dir = joinpath(@__DIR__, "datasets")
 const deploy_branch = "artifacts"
 
 """
-folder: e.g. `"Si2"`
-local_url: use local file path for the url, for testing only
+Create a artifact tarball for a folder.
+
+# Arguments
+- `folder`: subfolders in `datasets/` folder, e.g. `"Si2"`
+- `local_url`: use local file path for the url, for testing only
 """
 function create_artifact(folder::AbstractString; local_url::Bool = false)
     fullpath = joinpath(datasets_dir, folder)
@@ -92,16 +95,25 @@ function create_artifact(folder::AbstractString; local_url::Bool = false)
     return res
 end
 
+"""
+Get the git hash of the latest commit of a file.
+"""
 function git_hash(path::AbstractString; branch::AbstractString = "HEAD")
     return read(`git log -n 1 --pretty=format:"%H" $branch -- "$path"`, String)
 end
 
+"""
+Get the date of a git commit.
+"""
 function git_date(githash::AbstractString)
     # get the date of the commit, unix timestamp
     g = strip(read(`git show -s --format=%ct $githash`, String))
     return unix2datetime(parse(Float64, g))
 end
 
+"""
+Get list of artifact tarballs in the deploy branch.
+"""
 function list_previous_artifacts()
     # if this command fails with the error
     # `fatal: Not a valid object name artifacts`
@@ -113,6 +125,10 @@ function list_previous_artifacts()
     return Dict(f => git_hash(f; branch = deploy_branch) for f in files)
 end
 
+"""
+Get folder names in `datasets/` that are newer than the corresponding
+tarball.
+"""
 function list_new_folders()
     prev_artifacts = list_previous_artifacts()
 
@@ -135,6 +151,9 @@ function list_new_folders()
     return new_folders
 end
 
+"""
+Remove the `artifacts_dir` folder and create a new one.
+"""
 function clean_artifacts_dir()
     print("I will clean the `$(artifacts_dir)` folder [y/N]: ")
     n = readline()
@@ -148,13 +167,20 @@ function clean_artifacts_dir()
     return true
 end
 
-function (@main)(args)
-    toml_path = joinpath(@__DIR__, "Artifacts.toml")
-    if isfile(toml_path)
-        artifacts = TOML.parsefile(toml_path)
-    else
-        artifacts = Dict{String,Any}()
+"""
+Get previous Artifacts.toml from deploy branch.
+"""
+function read_artifact_toml()
+    return try
+        content = read(`git show $deploy_branch:Artifacts.toml`)
+        return TOML.parse(String(content))
+    catch e
+        return Dict{String,Any}()
     end
+end
+
+function (@main)(args)
+    artifacts = read_artifact_toml()
 
     new_folders = list_new_folders()
     if isempty(new_folders)
@@ -167,11 +193,12 @@ function (@main)(args)
 
         for folder in new_folders
             artifact = create_artifact(folder)
+            # existing entries will be replaced
             push!(artifacts, artifact)
             # break
         end
 
-        open(toml_path, "w") do io
+        open("Artifacts.toml", "w") do io
             TOML.print(io, artifacts)
         end
     end

release.sh

@@ -80,4 +80,4 @@ git fetch origin $DEPLOY_BRANCH:$DEPLOY_BRANCH
 echo "\n\n\n"  # Add some newlines for readability
 echo "Upload complete. Checking results at"
 echo "https://huggingface.co/datasets/atomology/WannierDatasets/tree/$DEPLOY_BRANCH"
-echo "https://huggingface.co/datasets/atomology/WannierDatasets/main/Artifacts.toml"
+echo "https://huggingface.co/datasets/atomology/WannierDatasets/blob/$DEPLOY_BRANCH/Artifacts.toml"