Switch to ITensorFormatter, improve TagBot workflow, etc. (#97)

mtfishman · web-flow · commit f4239f3e6dfa · 2026-02-13T14:56:53.000-05:00
diff --git a/.github/workflows/Registrator.yml b/.github/workflows/Registrator.yml
@@ -1,4 +1,5 @@
 name: Register Package
+
 on:
   workflow_dispatch:
   push:
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -1,25 +1,11 @@
 name: TagBot
+
 on:
   issue_comment:
     types:
       - created
   workflow_dispatch:
-    inputs:
-      lookback:
-        default: "3"
-permissions:
-  actions: read
-  checks: read
-  contents: write
-  deployments: read
-  issues: read
-  discussions: read
-  packages: read
-  pages: read
-  pull-requests: read
-  repository-projects: read
-  security-events: read
-  statuses: read
+
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
@@ -28,4 +14,5 @@ jobs:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          registry: ITensor/ITensorRegistry
           ssh: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/.github/workflows/Tests.yml b/.github/workflows/Tests.yml
@@ -1,4 +1,5 @@
 name: Tests
+
 on:
   push:
     branches:
@@ -9,6 +10,7 @@ on:
     paths-ignore:
       - 'docs/**'
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, converted_to_draft]
   workflow_dispatch:
 
 concurrency:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,5 +1,5 @@
 ci:
-  skip: [runic]
+  skip: [itensor-formatter]
 
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -13,8 +13,8 @@ repos:
   - id: end-of-file-fixer
     exclude_types: [markdown]  # incompatible with Literate.jl
 
-- repo: https://github.com/fredrikekre/runic-pre-commit
-  rev: v2.0.1
+- repo: https://github.com/ITensor/ITensorFormatter.jl
+  rev: v0.2.9
   hooks:
-  - id: runic
-    exclude: (/.*)?templates(/.*)?$
+    - id: itensor-formatter
+      exclude: (/.*)?templates(/.*)?$
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "ITensorPkgSkeleton"
 uuid = "3d388ab1-018a-49f4-ae50-18094d5f71ea"
-version = "0.3.26"
+version = "0.3.27"
 authors = ["ITensor developers <support@itensor.org> and contributors"]
 
 [workspace]
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/ITensorPkgSkeleton.jl/dev/)
 [![Build Status](https://github.com/ITensor/ITensorPkgSkeleton.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/ITensorPkgSkeleton.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ITensor/ITensorPkgSkeleton.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/ITensorPkgSkeleton.jl)
-[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
+[![Code Style](https://img.shields.io/badge/code_style-ITensor-purple)](https://github.com/ITensor/ITensorFormatter.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 ## Support
diff --git a/benchmark/benchmarks.jl b/benchmark/benchmarks.jl
@@ -1,5 +1,5 @@
-using ITensorPkgSkeleton
 using BenchmarkTools
+using ITensorPkgSkeleton
 
 SUITE = BenchmarkGroup()
 SUITE["rand"] = @benchmarkable rand(10)
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,5 @@
-using ITensorPkgSkeleton: ITensorPkgSkeleton
 using Documenter: Documenter, DocMeta, deploydocs, makedocs
+using ITensorPkgSkeleton: ITensorPkgSkeleton
 
 DocMeta.setdocmeta!(
     ITensorPkgSkeleton, :DocTestSetup, :(using ITensorPkgSkeleton); recursive = true
@@ -14,11 +14,12 @@ makedocs(;
     format = Documenter.HTML(;
         canonical = "https://itensor.github.io/ITensorPkgSkeleton.jl",
         edit_link = "main",
-        assets = ["assets/favicon.ico", "assets/extras.css"],
+        assets = ["assets/favicon.ico", "assets/extras.css"]
     ),
-    pages = ["Home" => "index.md", "Reference" => "reference.md"],
+    pages = ["Home" => "index.md", "Reference" => "reference.md"]
 )
 
 deploydocs(;
-    repo = "github.com/ITensor/ITensorPkgSkeleton.jl", devbranch = "main", push_preview = true
+    repo = "github.com/ITensor/ITensorPkgSkeleton.jl", devbranch = "main",
+    push_preview = true
 )
diff --git a/docs/make_index.jl b/docs/make_index.jl
@@ -1,5 +1,5 @@
-using Literate: Literate
 using ITensorPkgSkeleton: ITensorPkgSkeleton
+using Literate: Literate
 
 function ccq_logo(content)
     include_ccq_logo = """
@@ -17,5 +17,5 @@ Literate.markdown(
     joinpath(pkgdir(ITensorPkgSkeleton), "docs", "src");
     flavor = Literate.DocumenterFlavor(),
     name = "index",
-    postprocess = ccq_logo,
+    postprocess = ccq_logo
 )
diff --git a/docs/make_readme.jl b/docs/make_readme.jl
@@ -1,5 +1,5 @@
-using Literate: Literate
 using ITensorPkgSkeleton: ITensorPkgSkeleton
+using Literate: Literate
 
 function ccq_logo(content)
     include_ccq_logo = """
@@ -17,5 +17,5 @@ Literate.markdown(
     joinpath(pkgdir(ITensorPkgSkeleton));
     flavor = Literate.CommonMarkFlavor(),
     name = "README",
-    postprocess = ccq_logo,
+    postprocess = ccq_logo
 )
diff --git a/examples/README.jl b/examples/README.jl
@@ -4,7 +4,7 @@
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/ITensorPkgSkeleton.jl/dev/)
 # [![Build Status](https://github.com/ITensor/ITensorPkgSkeleton.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/ITensorPkgSkeleton.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 # [![Coverage](https://codecov.io/gh/ITensor/ITensorPkgSkeleton.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/ITensorPkgSkeleton.jl)
-# [![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
+# [![Code Style](https://img.shields.io/badge/code_style-ITensor-purple)](https://github.com/ITensor/ITensorFormatter.jl)
 # [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 # ## Support
diff --git a/src/ITensorPkgSkeleton.jl b/src/ITensorPkgSkeleton.jl
@@ -9,16 +9,15 @@ end
 
 using DocStringExtensions: SIGNATURES
 using Git: git
+using Git_jll: Git_jll
 using LibGit2: LibGit2
 using PkgSkeleton: PkgSkeleton
 using Preferences: Preferences
 using Suppressor: @suppress
 
 # Configure `Git.jl`/`Git_jll.jl` to
 # use the local installation of git.
-using Preferences: Preferences
-# Need to load to set the preferences.
-using Git_jll: Git_jll
+# Need to Preferences.jl to set the preferences.
 function use_system_git!()
     git_path = try
         readchomp(`which git`)
@@ -80,7 +79,8 @@ default_useremail() = "support@itensor.org"
 
 function default_user_replacements()
     return (
-        ghuser = default_ghuser(), username = default_username(), useremail = default_useremail(),
+        ghuser = default_ghuser(), username = default_username(),
+        useremail = default_useremail(),
     )
 end
 
@@ -175,6 +175,7 @@ end
 $(SIGNATURES)
 
 !!! warning
+
     This function might overwrite existing code if you specify a path to a package that already exists, use with caution! See [`PkgSkeleton.jl`](https://github.com/tpapp/PkgSkeleton.jl) for more details. If you are updating an existing package, make sure you save everything you want to keep (for example, commit all of your changes if it is a git repository).
 
 Generate a package template for a package, by default in the ITensor organization, or update an existing package. This is a wrapper around [`PkgSkeleton.generate`](https://github.com/tpapp/PkgSkeleton.jl) but with extra functionality, custom templates used in the ITensor organization, and defaults biased towards creating a package in the ITensor organization.
@@ -184,42 +185,50 @@ Generate a package template for a package, by default in the ITensor organizatio
 ```julia
 julia> using ITensorPkgSkeleton: ITensorPkgSkeleton;
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir());
+julia> ITensorPkgSkeleton.generate("NewPkg"; path = mktempdir());
+
+julia> ITensorPkgSkeleton.generate("NewPkg"; path = mktempdir());
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir());
+julia> ITensorPkgSkeleton.generate(
+           "NewPkg";
+           path = mktempdir(),
+           templates = ITensorPkgSkeleton.default_templates()
+       );
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), templates=ITensorPkgSkeleton.default_templates());
+julia> ITensorPkgSkeleton.generate("NewPkg"; path = mktempdir(), templates = ["github"]);
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), templates=["github"]);
+julia> ITensorPkgSkeleton.generate(
+           "NewPkg"; path = mktempdir(), templates = ["src", "github"]
+       );
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), templates=["src", "github"]);
+julia> ITensorPkgSkeleton.generate(
+           "NewPkg"; path = mktempdir(), ignore_templates = ["src", "github"]
+       );
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), ignore_templates=["src", "github"]);
+julia> ITensorPkgSkeleton.generate("NewPkg"; path = mktempdir(), ghuser = "MyOrg");
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), ghuser="MyOrg");
+julia> ITensorPkgSkeleton.generate(
+           "NewPkg"; path = mktempdir(), downstreampkgs = ["ITensors", "ITensorMPS"]
+       );
 
-julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=["ITensors", "ITensorMPS"]);
 ```
 
 # Arguments
 
-- `pkgname::AbstractString`: Name of the package (without the `.jl` extension). Replaces `{PKGNAME}` in the template.
+  - `pkgname::AbstractString`: Name of the package (without the `.jl` extension). Replaces `{PKGNAME}` in the template.
 
 # Keywords
 
-- `path::AbstractString`: Path where the package will be generated. Defaults to the [development directory](https://pkgdocs.julialang.org/v1/api/#Pkg.develop), i.e. `$(default_path())`.
-- `templates`: A list of templates to use. Select a subset of `ITensorPkgSkeleton.all_templates() = $(all_templates())`. Defaults to `ITensorPkgSkeleton.default_templates() = $(default_templates())`.
-- `ignore_templates`: A list of templates to ignore. This is the same as setting `templates=setdiff(templates, ignore_templates)`.
-- `downstreampkgs`: Specify the downstream packages that depend on this package. Setting this will create a workflow where the downstream tests will be run alongside the tests for this package in Github Actions to ensure that changes to your package don't break the specified downstream packages. Defaults to an empty list.
-- `uuid`: Replaces `{UUID}` in the template. Defaults to the existing UUID in the `Project.toml` if the path points to an existing package, otherwise generates one randomly with `UUIDs.uuid4()`.
-- `year`: Replaces `{YEAR}` in the template. Year the package/repository was created. Defaults to the current year.
+  - `path::AbstractString`: Path where the package will be generated. Defaults to the [development directory](https://pkgdocs.julialang.org/v1/api/#Pkg.develop), i.e. `$(default_path())`.
+  - `templates`: A list of templates to use. Select a subset of `ITensorPkgSkeleton.all_templates() = $(all_templates())`. Defaults to `ITensorPkgSkeleton.default_templates() = $(default_templates())`.
+  - `ignore_templates`: A list of templates to ignore. This is the same as setting `templates=setdiff(templates, ignore_templates)`.    # Process downstream package information.
+  - `downstreampkgs`: Specify the downstream packages that depend on this package. Setting this will create a workflow where the downstream tests will be run alongside the tests for this package in Github Actions to ensure that changes to your package don't break the specified downstream packages. Defaults to an empty list.
+  - `uuid`: Replaces `{UUID}` in the template. Defaults to the existing UUID in the `Project.toml` if the path points to an existing package, otherwise generates one randomly with `UUIDs.uuid4()`.
+  - `year`: Replaces `{YEAR}` in the template. Year the package/repository was created. Defaults to the current year.    # Check if there are downstream tests.
 """
 function generate(
-        pkgname;
-        path = default_path(),
-        templates = default_templates(),
-        ignore_templates = [],
-        user_replacements...,
+        pkgname; path = default_path(), templates = default_templates(),
+        ignore_templates = [], user_replacements...
     )
     pkgpath = joinpath(path, pkgname)
     user_replacements = merge(default_user_replacements(), user_replacements)
diff --git a/templates/docs/README.md b/templates/docs/README.md
@@ -4,7 +4,7 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/{PKGNAME}.jl/dev/)
 [![Build Status](https://github.com/ITensor/{PKGNAME}.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/{PKGNAME}.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ITensor/{PKGNAME}.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/{PKGNAME}.jl)
-[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
+[![Code Style](https://img.shields.io/badge/code_style-ITensor-purple)](https://github.com/ITensor/ITensorFormatter.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 ## Support
diff --git a/templates/downstreampkgs/.github/workflows/IntegrationTest.yml b/templates/downstreampkgs/.github/workflows/IntegrationTest.yml
@@ -8,6 +8,7 @@ on:
     paths:
       - 'Project.toml'
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, converted_to_draft]
     paths:
       - 'Project.toml'
 
diff --git a/templates/examples/examples/README.jl b/templates/examples/examples/README.jl
@@ -4,7 +4,7 @@
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/{PKGNAME}.jl/dev/)
 # [![Build Status](https://github.com/ITensor/{PKGNAME}.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/{PKGNAME}.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 # [![Coverage](https://codecov.io/gh/ITensor/{PKGNAME}.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/{PKGNAME}.jl)
-# [![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
+# [![Code Style](https://img.shields.io/badge/code_style-ITensor-purple)](https://github.com/ITensor/ITensorFormatter.jl)
 # [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 # ## Support
diff --git a/templates/github/.github/workflows/Registrator.yml b/templates/github/.github/workflows/Registrator.yml
@@ -1,4 +1,5 @@
 name: Register Package
+
 on:
   workflow_dispatch:
   push:
diff --git a/templates/github/.github/workflows/TagBot.yml b/templates/github/.github/workflows/TagBot.yml
@@ -1,25 +1,11 @@
 name: TagBot
+
 on:
   issue_comment:
     types:
       - created
   workflow_dispatch:
-    inputs:
-      lookback:
-        default: "3"
-permissions:
-  actions: read
-  checks: read
-  contents: write
-  deployments: read
-  issues: read
-  discussions: read
-  packages: read
-  pages: read
-  pull-requests: read
-  repository-projects: read
-  security-events: read
-  statuses: read
+
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
@@ -28,4 +14,5 @@ jobs:
       - uses: JuliaRegistries/TagBot@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          registry: ITensor/ITensorRegistry
           ssh: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/templates/github/.github/workflows/Tests.yml b/templates/github/.github/workflows/Tests.yml
@@ -1,4 +1,5 @@
 name: Tests
+
 on:
   push:
     branches:
@@ -9,6 +10,7 @@ on:
     paths-ignore:
       - 'docs/**'
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, converted_to_draft]
   workflow_dispatch:
 
 concurrency:
diff --git a/templates/precommit/.pre-commit-config.yaml b/templates/precommit/.pre-commit-config.yaml
@@ -1,5 +1,5 @@
 ci:
-  skip: [runic]
+  skip: [itensor-formatter]
 
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -11,7 +11,7 @@ repos:
   - id: end-of-file-fixer
     exclude_types: [markdown]  # incompatible with Literate.jl
 
-- repo: https://github.com/fredrikekre/runic-pre-commit
-  rev: v2.0.1
+- repo: https://github.com/ITensor/ITensorFormatter.jl
+  rev: v0.2.9
   hooks:
-  - id: runic
+    - id: itensor-formatter
diff --git a/test/basics/test_basics.jl b/test/basics/test_basics.jl
@@ -20,7 +20,9 @@ using Test: @test, @testset
         for dir in pkgdirs
             @test isdir(joinpath(path, "NewPkg", dir))
         end
-        @test !isfile(joinpath(path, "NewPkg", ".github", "workflows", "IntegrationTest.yml"))
+        @test !isfile(
+            joinpath(path, "NewPkg", ".github", "workflows", "IntegrationTest.yml")
+        )
     end
     @testset "generate with downstream tests" begin
         for templates in (ITensorPkgSkeleton.default_templates(), [])
@@ -33,7 +35,8 @@ using Test: @test, @testset
                     joinpath(path, "NewPkg", ".github", "workflows", "IntegrationTest.yml")
                 )
                 @test open(
-                    joinpath(path, "NewPkg", ".github", "workflows", "IntegrationTest.yml"), "r"
+                    joinpath(path, "NewPkg", ".github", "workflows", "IntegrationTest.yml"),
+                    "r"
                 ) do io
                     return contains(read(io, String), "- 'DownstreamPkg'")
                 end
diff --git a/test/runtests.jl b/test/runtests.jl
diff --git a/test/test_aqua.jl b/test/test_aqua.jl

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: Register Package`
	`2`	`+`
`2`	`3`	`on:`
`3`	`4`	`workflow_dispatch:`
`4`	`5`	`push:`