Skeleton updates (#3)

.github/workflows/Documentation.yml

@@ -0,0 +1,23 @@
+name: "Documentation"
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+  schedule:
+    - cron: '1 4 * * 4'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch || github.ref != 'refs/tags/v*' }}
+
+jobs:
+  build-and-deploy-docs:
+    name: "Documentation"
+    uses: "ITensor/ITensorActions/.github/workflows/Documentation.yml@main"
+    with:
+      localregistry: https://github.com/ITensor/ITensorRegistry.git
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/FormatCheck.yml

@@ -1,35 +1,13 @@
-name: Format check
+name: "Format Check"
+
 on:
   push:
-    branches: [main]
-    tags: [v*]
+    branches:
+      - 'main'
+    tags: '*'
   pull_request:
 
 jobs:
-  format:
+  format-check:
     name: "Format Check"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: 1
-      - name: Install JuliaFormatter and format
-        run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
-      - name: Check format
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "The following files have not been formatted:"
-              write(stdout, out)
-              out_diff = Cmd(`git diff`) |> read |> String
-              @error "Diff:"
-              write(stdout, out_diff)
-              exit(1)
-              @error ""
-          end'
+    uses: "ITensor/ITensorActions/.github/workflows/FormatCheck.yml@main"

.github/workflows/LiterateCheck.yml

@@ -1,39 +1,15 @@
-name: Literate check
+name: "Literate Check"
+
 on:
   push:
-    branches: [main]
-    tags: [v*]
+    branches:
+      - 'main'
+    tags: '*'
   pull_request:
 
 jobs:
   literate:
     name: "Literate Check"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: 1
-      - name: Install Literate and generate docs
-        run: |
-          julia  -e '
-          using Pkg
-          Pkg.develop(PackageSpec(path=pwd()))
-          Pkg.instantiate()
-          Pkg.add(PackageSpec(name="Literate"))'
-          julia  -e 'include("docs/make_readme.jl")'
-      - name: Check if docs need to be updated
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "The docs are outdated, rerun Literate to regenerate them."
-              write(stdout, out)
-              out_diff = Cmd(`git diff`) |> read |> String
-              @error "Diff:"
-              write(stdout, out_diff)
-              exit(1)
-              @error ""
-          end'
+    uses: "ITensor/ITensorActions/.github/workflows/LiterateCheck.yml@main"
+    with:
+      localregistry: https://github.com/ITensor/ITensorRegistry.git

.github/workflows/Tests.yml

@@ -0,0 +1,42 @@
+name: Tests
+on:
+  push:
+    branches:
+      - 'master'
+      - 'main'
+      - 'release-'
+    tags: '*'
+    paths-ignore:
+      - 'docs/**'
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  # Cancel intermediate builds: only if it is a pull request build.
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  tests:
+    name: "Tests"
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 'lts' # minimal supported version
+          - '1' # latest released Julia version
+        # group:
+        #   - 'core'
+        #   - 'optional'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+    uses: "ITensor/ITensorActions/.github/workflows/Tests.yml@main"
+    with:
+      group: "${{ matrix.group }}"
+      julia-version: "${{ matrix.version }}"
+      os: "${{ matrix.os }}"
+      localregistry: https://github.com/ITensor/ITensorRegistry.git
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.pre-commit-config.yaml

@@ -7,7 +7,8 @@ repos:
   - id: check-yaml
   - id: end-of-file-fixer
     exclude_types: [markdown]  # incompatible with Literate.jl
-- repo: https://github.com/qiaojunfeng/pre-commit-julia-format
-  rev: v0.2.0
+
+- repo: "https://github.com/domluna/JuliaFormatter.jl"
+  rev: v1.0.62  
   hooks:
-  - id: julia-format
+  - id: "julia-formatter"

Project.toml

@@ -1,16 +1,7 @@
 name = "BroadcastMapConversion"
 uuid = "4a4adec5-520f-4750-bb37-d5e66b4ddeb2"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.1.0"
+version = "0.1.1"
 
 [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"]

README.md

@@ -2,17 +2,31 @@
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/BroadcastMapConversion.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/BroadcastMapConversion.jl/dev/)
-[![Build Status](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Build Status](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ITensor/BroadcastMapConversion.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/BroadcastMapConversion.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)
 
 ## Installation instructions
 
+This package resides in the `ITensor/ITensorRegistry` local registry.
+In order to install, simply add that registry through your package manager.
+This step is only required once.
 ```julia
 julia> using Pkg: Pkg
 
-julia> Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+```
+or:
+```julia
+julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
+```
+if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
+
+Then, the package can be added as usual through the package manager:
+
+```julia
+julia> Pkg.add("BroadcastMapConversion")
 ```
 
 ## Examples

examples/README.jl

@@ -2,18 +2,36 @@
 # 
 # [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/BroadcastMapConversion.jl/stable/)
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/BroadcastMapConversion.jl/dev/)
-# [![Build Status](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/CI.yml?query=branch%3Amain)
+# [![Build Status](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/BroadcastMapConversion.jl/actions/workflows/Tests.yml?query=branch%3Amain)
 # [![Coverage](https://codecov.io/gh/ITensor/BroadcastMapConversion.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/BroadcastMapConversion.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)
 
 # ## Installation instructions
 
+# This package resides in the `ITensor/ITensorRegistry` local registry.
+# In order to install, simply add that registry through your package manager.
+# This step is only required once.
 #=
 ```julia
 julia> using Pkg: Pkg
 
-julia> Pkg.add(url="https://github.com/ITensor/BroadcastMapConversion.jl")
+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+```
+=#
+# or:
+#=
+```julia
+julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
+```
+=#
+# if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
+
+# Then, the package can be added as usual through the package manager:
+
+#=
+```julia
+julia> Pkg.add("BroadcastMapConversion")
 ```
 =#
 

test/Project.toml

@@ -1,3 +1,12 @@
 [deps]
 BroadcastMapConversion = "4a4adec5-520f-4750-bb37-d5e66b4ddeb2"
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
+Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[compat]
+Aqua = "0.8.9"
+SafeTestsets = "0.1"
+Suppressor = "0.2"
+Test = "1.10"