Initial commit with first draft template

.JuliaFormatter.toml

@@ -1,2 +1,3 @@
 # See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options
 style = "blue"
+indent = 2

Project.toml

@@ -4,6 +4,8 @@ authors = ["ITensor developers <[email protected]> and contributors"]
 version = "0.1.0"
 
 [compat]
+Aqua = "0.8.9"
+Test = "1.10"
 julia = "1.10"
 
 [extras]

docs/make.jl

@@ -1,23 +1,20 @@
 using ITensorPkgSkeleton
 using Documenter
 
-DocMeta.setdocmeta!(ITensorPkgSkeleton, :DocTestSetup, :(using ITensorPkgSkeleton); recursive=true)
+DocMeta.setdocmeta!(
+  ITensorPkgSkeleton, :DocTestSetup, :(using ITensorPkgSkeleton); recursive=true
+)
 
 makedocs(;
-    modules=[ITensorPkgSkeleton],
-    authors="ITensor developers <[email protected]> and contributors",
-    sitename="ITensorPkgSkeleton.jl",
-    format=Documenter.HTML(;
-        canonical="https://ITensor.github.io/ITensorPkgSkeleton.jl",
-        edit_link="main",
-        assets=String[],
-    ),
-    pages=[
-        "Home" => "index.md",
-    ],
+  modules=[ITensorPkgSkeleton],
+  authors="ITensor developers <[email protected]> and contributors",
+  sitename="ITensorPkgSkeleton.jl",
+  format=Documenter.HTML(;
+    canonical="https://ITensor.github.io/ITensorPkgSkeleton.jl",
+    edit_link="main",
+    assets=String[],
+  ),
+  pages=["Home" => "index.md"],
 )
 
-deploydocs(;
-    repo="github.com/ITensor/ITensorPkgSkeleton.jl",
-    devbranch="main",
-)
+deploydocs(; repo="github.com/ITensor/ITensorPkgSkeleton.jl", devbranch="main")

templates/default/.JuliaFormatter.toml

@@ -0,0 +1,3 @@
+# See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options
+style = "blue"
+indent = 2

templates/default/.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

templates/default/.github/workflows/CI.yml

@@ -0,0 +1,79 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+    tags: ['*']
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 60
+    permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      actions: write
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.10'
+          - 'lts'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v4
+        with:
+          files: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      contents: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - name: Configure doc environment
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Pkg
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - name: Run doctests
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Documenter: DocMeta, doctest
+          using {PKGNAME}
+          DocMeta.setdocmeta!({PKGNAME}, :DocTestSetup, :(using {PKGNAME}); recursive=true)
+          doctest({PKGNAME})

templates/default/.github/workflows/CompatHelper.yml

@@ -0,0 +1,16 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

templates/default/.github/workflows/Register.yml

@@ -0,0 +1,16 @@
+name: Register Package
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version to register or component to bump
+        required: true
+jobs:
+  register:
+    runs-on: ubuntu-latest
+    permissions:
+        contents: write
+    steps:
+      - uses: julia-actions/RegisterAction@latest
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

templates/default/.github/workflows/TagBot.yml

@@ -0,0 +1,31 @@
+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'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

templates/default/.gitignore

@@ -0,0 +1,14 @@
+*.jl.*.cov
+*.jl.cov
+*.jl.mem
+*.o
+*.swp
+.DS_Store
+.benchmarkci
+.tmp
+.vscode/
+/docs/Manifest.toml
+/docs/build/
+Manifest.toml
+benchmark/*.json
+docs/build/

templates/default/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ITensor developers <[email protected]> and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

templates/default/Project.toml

@@ -0,0 +1,16 @@
+name = "{PKGNAME}"
+uuid = "{UUID}"
+authors = ["ITensor developers <[email protected]> and contributors"]
+version = "0.1.0"
+
+[compat]
+Aqua = "0.8.9"
+Test = "1.10"
+julia = "1.10"
+
+[extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Aqua", "Test"]

templates/default/README.md

@@ -0,0 +1,8 @@
+# {PKGNAME}.jl
+
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/{PKGNAME}.jl/stable/)
+[![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/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/{PKGNAME}.jl/actions/workflows/CI.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: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
+[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

templates/default/benchmark/benchmarks.jl

@@ -0,0 +1,7 @@
+using {PKGNAME}
+using BenchmarkTools
+
+SUITE = BenchmarkGroup()
+SUITE["rand"] = @benchmarkable rand(10)
+
+# Write your benchmarks here.

templates/default/docs/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+{PKGNAME} = "70ffe8f8-8519-465d-b12c-3b7d28f4e5e2"

templates/default/docs/make.jl

@@ -0,0 +1,16 @@
+using {PKGNAME}: {PKGNAME}
+using Documenter: Documenter
+
+DocMeta.setdocmeta!({PKGNAME}, :DocTestSetup, :(using {PKGNAME}); recursive=true)
+
+makedocs(;
+  modules=[{PKGNAME}],
+  authors="ITensor developers <[email protected]> and contributors",
+  sitename="{PKGNAME}.jl",
+  format=Documenter.HTML(;
+    canonical="https://ITensor.github.io/{PKGNAME}.jl", edit_link="main", assets=String[]
+  ),
+  pages=["Home" => "index.md"],
+)
+
+deploydocs(; repo="github.com/ITensor/{PKGNAME}.jl", devbranch="main")

templates/default/docs/src/index.md

@@ -0,0 +1,14 @@
+```@meta
+CurrentModule = {PKGNAME}
+```
+
+# {PKGNAME}
+
+Documentation for [{PKGNAME}](https://github.com/ITensor/{PKGNAME}.jl).
+
+```@index
+```
+
+```@autodocs
+Modules = [{PKGNAME}]
+```

templates/default/src/PKGNAME.jl

@@ -0,0 +1,5 @@
+module {PKGNAME}
+
+# Write your package code here.
+
+end

templates/default/test/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+{PKGNAME} = "{UUID}"
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

templates/default/test/runtests.jl

@@ -0,0 +1,13 @@
+@eval module $(gensym())
+using {PKGNAME}: {PKGNAME}
+using Test: @testset
+
+@testset "{PKGNAME}.jl" begin
+  filenames = filter(readdir(@__DIR__)) do f
+    startswith("test_")(f) && endswith(".jl")(f)
+  end
+  @testset "Test $filename" for filename in filenames
+    include(filename)
+  end
+end
+end

templates/default/test/test_aqua.jl

@@ -0,0 +1,9 @@
+@eval module $(gensym())
+using {PKGNAME}: {PKGNAME}
+using Aqua: Aqua
+using Test: @testset
+
+@testset "Code quality (Aqua.jl)" begin
+  Aqua.test_all({PKGNAME})
+end
+end

test/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+ITensorPkgSkeleton = "3d388ab1-018a-49f4-ae50-18094d5f71ea"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/runtests.jl

@@ -1,10 +1,13 @@
-using ITensorPkgSkeleton
-using Test
-using Aqua
+@eval module $(gensym())
+using ITensorPkgSkeleton: ITensorPkgSkeleton
+using Test: @testset
 
 @testset "ITensorPkgSkeleton.jl" begin
-    @testset "Code quality (Aqua.jl)" begin
-        Aqua.test_all(ITensorPkgSkeleton)
-    end
-    # Write your tests here.
+  filenames = filter(readdir(@__DIR__)) do f
+    startswith("test_")(f) && endswith(".jl")(f)
+  end
+  @testset "Test $filename" for filename in filenames
+    include(filename)
+  end
+end
 end

test/test_aqua.jl

@@ -0,0 +1,9 @@
+@eval module $(gensym())
+using Aqua: Aqua
+using ITensorPkgSkeleton: ITensorPkgSkeleton
+using Test: @testset
+
+@testset "Code quality (Aqua.jl)" begin
+  Aqua.test_all(ITensorPkgSkeleton)
+end
+end