Clean up make_artifacts.jl

.gitignore

@@ -26,3 +26,6 @@ Manifest.toml
 # Do not commit large (and redundant) tar.gz files, instead, I upload them
 # to the `artifacts` branch
 artifacts/*.tar.gz
+
+# vscode
+.vscode

docs/CONTRIBUTING.md

@@ -54,3 +54,17 @@ We actively welcome your pull requests:
     we can merge your PR without ugly :worried: merge commits.
     Otherwise, we will rebase explicitly your branch when merging.
 6. Create that pull request!
+
+## Release process
+
+```shell
+# make tarballs
+./make_artifacts.jl
+
+# upload tarballs to huggingface `artifacts` branch, see the output of `make_artifacts.jl`
+huggingface-cli upload # ...
+
+# auto bump the version & create git tag with release-it
+# https://github.com/release-it/release-it
+release-it --no-push
+```

docs/GitHub_actions.md

@@ -1,30 +0,0 @@
-# Notes on GitHub Actions
-
-## Release process
-
-The current process of bumping version is:
-
-- create a branch, since the `main` branch is protected.
-  The branch name can be `bumpversion`.
-- use `bump2version (major|minor|patch)` to update
-  `.bumpversion.cfg` and `Project.toml`, and it will create a git commit
-- create a PR
-- the release workflow will run, it will
-  - build the artifact tarballs
-  - commit `Artifacts.toml`
-  - create a draft release, with tarballs attached
-  - check if the version in `Project.toml` is consistent with that suggested
-    by the `release-drafter` workflow, and if not, add a comment to the PR
-- once the PR is merged, publish the draft release, and it will create
-  a git tag pointing to main (thus including the just merged PR)
-
-In the end, we have:
-
-- a new version git tagged
-- an `Artifacts.toml` with updated tarball SHA
-- a GitHub release with tarballs attached
-- the version in `Project.toml` is consistent with the git tag
-
-## Debugging
-
-- to debug github workflows, set `ACTIONS_STEP_DEBUG` to `true` in secrets

make_artifacts.jl

@@ -11,14 +11,15 @@
 using Tar, Inflate, SHA, TOML
 using Dates: unix2datetime
 
+const artifacts_dir = joinpath(@__DIR__, "artifacts")
+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
 """
 function create_artifact(folder::AbstractString; local_url::Bool=false)
-    artifacts_dir = joinpath(@__DIR__, "artifacts")
-    datasets_dir = joinpath(@__DIR__, "datasets")
-
     fullpath = joinpath(datasets_dir, folder)
     isdir(fullpath) || return
 
@@ -71,12 +72,20 @@ function create_artifact(folder::AbstractString; local_url::Bool=false)
     end
 
     artifact_name = folder
-    return artifact_name => Dict(
+    res = artifact_name => Dict(
         "git-tree-sha1" => Tar.tree_hash(IOBuffer(inflate_gzip(outpath))),
         "lazy" => true,
         "download" =>
             [Dict("url" => url, "sha256" => bytes2hex(open(sha256, outpath)))],
     )
+
+    # print the result as toml
+    buf = IOBuffer()
+    TOML.print(buf, Dict(res))
+    s = String(take!(buf))
+    @info "New artifact:\n$s"
+
+    return res
 end
 
 function git_hash(path::AbstractString; branch::AbstractString="HEAD")
@@ -90,15 +99,12 @@ function git_date(githash::AbstractString)
 end
 
 function list_previous_artifacts()
-    branch = "artifacts"
-    files = split(read(`git ls-tree -r --name-only $branch`, String))
+    files = split(read(`git ls-tree -r --name-only $deploy_branch`, String))
     filter!(f -> endswith(f, ".tar.gz"), files)
-    return Dict(f => git_hash(f; branch) for f in files)
+    return Dict(f => git_hash(f; deploy_branch) for f in files)
 end
 
 function list_new_folders()
-    datasets_dir = joinpath(@__DIR__, "datasets")
-
     prev_artifacts = list_previous_artifacts()
 
     new_folders = String[]
@@ -122,14 +128,26 @@ end
 
 function upload_artifacts(names::AbstractVector)
     paths = map(names) do name
-        joinpath(@__DIR__, "artifacts", "$(name).tar.gz")
+        joinpath(artifacts_dir, "$(name).tar.gz")
     end
-    paths
+    println("huggingface-cli upload --repo-type dataset --revision $deploy_branch atomology/WannierDatasets \\")
+    println(join(paths, " \\\n"))
 end
 
-function (@main)(args)
-    new_folders = list_new_folders()
+function clean_artifacts_dir()
+    print("I will clean the `$(artifacts_dir)` folder [y/N]: ")
+    n = readline()
+    if lowercase(n) != "y"
+        println("Aborting...")
+        return false
+    end
+    rm(artifacts_dir; force=true, recurive=true)
+    mkpath(artifacts_dir)
+    println("Cleaned `$(artifacts_dir)` folder.")
+    return true
+end
 
+function (@main)(args)
     toml_path = joinpath(@__DIR__, "Artifacts.toml")
     if isfile(toml_path)
         artifacts = TOML.parsefile(toml_path)
@@ -137,21 +155,20 @@ function (@main)(args)
         artifacts = Dict{String, Any}()
     end
 
-    for folder in new_folders
-        artifact = create_artifact(folder)
+    new_folders = list_new_folders()
 
-        # print the result as toml
-        buf = IOBuffer()
-        TOML.print(buf, Dict(artifact))
-        s = String(take!(buf))
-        @info "New artifact:\n$s"
+    if length(args) > 0 && args[1] != "dryrun"
+        clean_artifacts_dir() || return
 
-        push!(artifacts, artifact)
-        break
-    end
+        for folder in new_folders
+            artifact = create_artifact(folder)
+            push!(artifacts, artifact)
+            # break
+        end
 
-    open(toml_path, "w") do io
-        TOML.print(io, artifacts)
+        open(toml_path, "w") do io
+            TOML.print(io, artifacts)
+        end
     end
 
     upload_artifacts(new_folders)