Merge pull request #88 from isentropic/master

Migrate to documenter jl, + doc upgrades

.github/workflows/CleanPreview.yml

@@ -0,0 +1,27 @@
+# from https://github.com/CliMA/ClimaTimeSteppers.jl
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

.github/workflows/PRComment.yml

@@ -0,0 +1,14 @@
+name: Doc Preview PR Comment
+on:
+  pull_request:
+    types: [labeled]
+jobs:
+  pr_comment:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create PR comment
+        if: github.event_name == 'pull_request' && github.repository == github.event.pull_request.head.repo.full_name && github.event.label.name == 'documentation' # if this is a pull request build AND the pull request is NOT made from a fork
+        uses: thollander/actions-comment-pull-request@71efef56b184328c7ef1f213577c3a90edaa4aff
+        with:
+          message: 'Once the documentation build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/DataAugmentation.jl/previews/PR${{ github.event.number }}/'
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -1,28 +1,80 @@
 name: CI
+
 on:
-  - push
-  - pull_request
+  push:
+      branches: ['master']
+  pull_request:
+      branches: ['master']
+
+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 }}
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         version:
-          - '1.6'
           - '1'
+          - '1.6' # this is the oldest compat
+          - 'nightly'
         os:
           - ubuntu-latest
           - macOS-latest
           - windows-latest
         arch:
           - x64
+          - x86
+        exclude:
+          - os: macOS-latest
+            arch: x86
     steps:
       - uses: actions/checkout@v3
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: julia-actions/julia-buildpkg@latest
-      - uses: julia-actions/julia-runtest@latest
-
+      - uses: actions/cache@v3
+        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 }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.6'
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - run: |
+          julia --color=yes --project=docs/ -e '
+            using DataAugmentation
+            using Documenter
+            using Documenter: doctest
+            DocMeta.setdocmeta!(DataAugmentation,
+                                :DocTestSetup,
+                                :(using DataAugmentation);
+                                recursive=true)
+            doctest(DataAugmentation)'
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

README.md

@@ -1,5 +1,9 @@
 # DataAugmentation.jl
 
+![CI](https://github.com/FluxML/DataAugmentation.jl/actions/workflows/CI/badge.svg)
+![compat](https://github.com/FluxML/DataAugmentation.jl/actions/workflows/CompatHelper/badge.svg)
+
+
 [Documentation | Latest](https://fluxml.github.io/DataAugmentation.jl/dev/documents/README.md)
 
 Efficient, composable data augmentation for machine and deep learning with support for n-dimensional images, keypoints and categorical masks.

docs/Project.toml

@@ -1,14 +1,11 @@
 [deps]
-Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
 DataAugmentation = "88a5189c-e7ff-4f85-ac6b-e6158070f02e"
-FilePathsBase = "48062228-2e41-5def-b9a4-89aafe57970f"
-ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19"
-ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ImageShow = "4e3cecfd-b093-5904-9786-8bbb286a6a31"
 Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
-JuliaSyntax = "70703baa-626e-46a2-a12c-08ffd08c73b4"
-ModuleInfo = "3c3ff5e7-c68c-4a09-80d1-9526a1e9878a"
 MosaicViews = "e94cdb99-869f-56ef-bcf0-1ae2bcbe0389"
-Pollen = "c88717ad-5130-4874-a664-5a9aba5ec443"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
+
+[compat]
+Documenter = "1.2"