CI configuration

.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"

.github/workflows/CI.yml

@@ -0,0 +1,88 @@
+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 }} - ${{ github.event_name }}
+    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.6'
+          - '1'
+        os:
+          - ubuntu-20.04
+        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
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
+      - name: Install Julia dependencies and run tests
+        run: |
+          JULIA_REFERENCETESTS_UPDATE=true DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --depwarn=yes -e 'using Pkg; Pkg.activate(temp=true); Pkg.develop(path="."); Pkg.test("ITensorMakie")'
+      - 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 ITensorMakie
+##          DocMeta.setdocmeta!(ITensorMakie, :DocTestSetup, :(using ITensorMakie); recursive=true)
+##          doctest(ITensorMakie)

.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()'

.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 }}

.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 }}

.gitignore

@@ -0,0 +1,2 @@
+.*.swp
+Manifest.toml

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

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

docs/src/index.md

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