Merge pull request #19 from JuliaImageRecon/yml

Update compat and yml files

.github/workflows/CompatHelper.yml

@@ -1,4 +1,5 @@
 name: CompatHelper
+
 on:
   schedule:
     - cron: 0 0 * * 0 # weekly
@@ -8,13 +9,25 @@ jobs:
   CompatHelper:
     runs-on: ubuntu-latest
     steps:
-      - name: Pkg.add("CompatHelper")
-        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
-      - name: CompatHelper.main()
+      - name: "Add the General registry via Git"
+        run: |
+          import Pkg
+          ENV["JULIA_PKG_SERVER"] = ""
+          Pkg.Registry.add("General")
+        shell: julia --color=yes {0}
+      - name: "Install CompatHelper"
+        run: |
+          import Pkg
+          name = "CompatHelper"
+          uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
+          version = "3"
+          Pkg.add(; name, uuid, version)
+        shell: julia --color=yes {0}
+      - name: "Run CompatHelper"
+        run: |
+          import CompatHelper
+          CompatHelper.main()
+        shell: julia --color=yes {0}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} # need ssh
-        run: julia -e 'using CompatHelper; CompatHelper.main()'
-
-# based on:
-# https://github.com/JuliaRegistries/CompatHelper.jl
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/Documentation.yml

@@ -2,7 +2,11 @@ name: Documentation
 
 on:
   pull_request:
+    paths-ignore:
+      - 'README.md'
   push:
+    paths-ignore:
+      - 'README.md'
     branches:
       - 'main'
       - 'release-'

.github/workflows/TagBot.yml

@@ -1,9 +1,11 @@
 name: TagBot
+
 on:
   issue_comment:
     types:
       - created
   workflow_dispatch:
+
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  create:
+    tags:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.version == 'nightly' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version: ['1.6', '1', 'nightly']
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+    steps:
+      - uses: actions/checkout@v2
+#     - name: "Set up Julia"
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.version }}
+#     - name: "Unit Test"
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-runtest@latest
+#     - name: "Cover"
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        if: ${{ matrix.version == '1' && matrix.os == 'ubuntu-latest' }}
+        with:
+          file: lcov.info

Project.toml

@@ -1,7 +1,7 @@
 name = "ImageGeoms"
 uuid = "9ee76f2b-840d-4475-b6d6-e485c9297852"
 authors = ["Jeff Fessler <[email protected]>"]
-version = "0.5.0"
+version = "0.5.1"
 
 [deps]
 FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
@@ -10,6 +10,6 @@ Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 
 [compat]
 FillArrays = "0.12"
-LazyGrids = "0.2.0"
+LazyGrids = "0.2, 0.3"
 Requires = "1.3"
 julia = "1.6"

docs/Project.toml

@@ -1,6 +1,7 @@
 [deps]
 AxisArrays = "39de3d68-74b9-583c-8d2d-e117c070f3a9"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 MIRTjim = "170b2178-6dee-4cb0-8729-b3e8b57834cc"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
@@ -9,6 +10,3 @@ Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 UnitfulRecipes = "42071c24-d89e-48dd-8a24-8a12d9b8861f"
 
 [compat]
-Documenter = "0.27.3"
-Literate = "2"
-MIRTjim = "0.11"

docs/lit/examples/1-overview.jl

@@ -198,9 +198,7 @@ ig_over = oversample(ig, (2,2))
 
 # This page was generated with the following version of Julia:
 
-io = IOBuffer()
-versioninfo(io)
-split(String(take!(io)), '\n')
+io = IOBuffer(); versioninfo(io); split(String(take!(io)), '\n')
 
 
 # And with the following package versions

docs/lit/examples/2-mask.jl

@@ -113,9 +113,7 @@ embed!(array, core, ig.mask)
 
 # This page was generated with the following version of Julia:
 
-io = IOBuffer()
-versioninfo(io)
-split(String(take!(io)), '\n')
+io = IOBuffer(); versioninfo(io); split(String(take!(io)), '\n')
 
 
 # And with the following package versions

docs/make.jl

@@ -1,6 +1,7 @@
 execute = isempty(ARGS) || ARGS[1] == "run"
 
-using ImageGeoms
+org, reps = :JuliaImageRecon, :ImageGeoms
+eval(:(using $reps))
 using Documenter
 using Literate
 
@@ -13,7 +14,7 @@ lit = joinpath(@__DIR__, "lit")
 src = joinpath(@__DIR__, "src")
 gen = joinpath(@__DIR__, "src/generated")
 
-base = "JuliaImageRecon/ImageGeoms.jl"
+base = "$org/$reps.jl"
 repo_root_url =
     "https://github.com/$base/blob/main/docs/lit/examples"
 nbviewer_root_url =
@@ -22,7 +23,8 @@ binder_root_url =
     "https://mybinder.org/v2/gh/$base/gh-pages?filepath=dev/generated/examples"
 
 
-DocMeta.setdocmeta!(ImageGeoms, :DocTestSetup, :(using ImageGeoms); recursive=true)
+repo = eval(:($reps))
+DocMeta.setdocmeta!(repo, :DocTestSetup, :(using $reps); recursive=true)
 
 for (root, _, files) in walkdir(lit), file in files
     splitext(file)[2] == ".jl" || continue # process .jl files only
@@ -45,14 +47,14 @@ isci = get(ENV, "CI", nothing) == "true"
 format = Documenter.HTML(;
     prettyurls = isci,
     edit_link = "main",
-    canonical = "https://JuliaImageRecon.github.io/ImageGeoms.jl/stable/",
-#   assets = String[],
+    canonical = "https://$org.github.io/$repo.jl/stable/",
+    assets = ["assets/custom.css"],
 )
 
 makedocs(;
-    modules = [ImageGeoms],
+    modules = [repo],
     authors = "Jeff Fessler and contributors",
-    sitename = "ImageGeoms.jl",
+    sitename = "$repo.jl",
     format,
     pages = [
         "Home" => "index.md",
@@ -69,6 +71,6 @@ if isci
         versions = ["stable" => "v^", "dev" => "dev"],
         forcepush = true,
 #       push_preview = true,
-        # see https://JuliaImageRecon.github.io/ImageGeoms.jl/previews/PR##
+        # see https://$org.github.io/$repo.jl/previews/PR##
     )
 end

docs/src/assets/custom.css

@@ -0,0 +1,3 @@
+.docs-sourcelink {
+    opacity:1 !important;
+}

docs/src/index.md

@@ -6,7 +6,9 @@ CurrentModule = ImageGeoms
 
 ## Overview
 
-This Julia module exports a composite type `ImageGeom`
+This Julia package
+[ImageGeoms.jl](https://github.com/JuliaImageRecon/ImageGeoms.jl)
+exports a composite type `ImageGeom`
 and corresponding constructors
 for describing the image sampling geometry
 for (typically tomographic) image reconstruction.