.JuliaFormatter.toml

@@ -0,0 +1,11 @@
+short_to_long_function_def = true
+always_for_in = true
+whitespace_ops_in_indices = true
+pipe_to_function_call = true
+import_to_using = true
+always_use_return = true
+whitespace_in_kwargs = false
+remove_extra_newlines = true
+annotate_untyped_fields_with_any = false
+conditional_to_if = false
+ignore = ["tutorials", ".git"]

.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/disabled/IntegrationTest.yml

@@ -0,0 +1,48 @@
+name: IntegrationTest
+on:
+  push:
+    branches: [master]
+    tags: [v*]
+  pull_request:
+
+jobs:
+  test:
+    name: ${{ matrix.package.repo }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        julia-version: [1]
+        os: [ubuntu-latest]
+        package:
+          - {user: JuliaManifolds, repo: Manopt.jl}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.julia-version }}
+          arch: x64
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@latest
+      - name: Clone Downstream
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ matrix.package.user }}/${{ matrix.package.repo }}
+          path: downstream
+      - name: Load this and run the downstream tests
+        shell: julia --project=downstream {0}
+        run: |
+          using Pkg
+          try
+            # force it to use this PR's version of the package
+            Pkg.develop(PackageSpec(path="."))  # resolver may fail with main deps
+            Pkg.update()
+            Pkg.test()  # resolver may fail with test time deps
+          catch err
+            err isa Pkg.Resolve.ResolverError || rethrow()
+            # If we can't resolve that means this is incompatible by SemVer and this is fine
+            # It means we marked this as a breaking change, so we don't need to worry about
+            # Mistakenly introducing a breaking change, as we have intentionally made one
+            @info "Not compatible with this release. No problem." exception=err
+            exit(0)  #  Exit immediately, as a success
+          end

.github/workflows/CompatHelper.yml

@@ -1,19 +1,25 @@
 name: CompatHelper
-
 on:
   schedule:
-    - cron: '00 00 * * *'
-
+    - cron: 0 0 * * *
+  workflow_dispatch:
 jobs:
   CompatHelper:
     runs-on: ubuntu-latest
     steps:
-      - uses: julia-actions/setup-julia@latest
-        with:
-          version: 1.3
-      - name: Pkg.add("CompatHelper")
-        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
-      - name: CompatHelper.main()
+      - 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.COMPATHELPER_PAT }}
-        run: julia -e 'using CompatHelper; CompatHelper.main()'
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/TagBot.yml

@@ -1,9 +1,12 @@
 name: TagBot
 on:
-  schedule:
-    - cron: 0 * * * *
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
 jobs:
   TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
     runs-on: ubuntu-latest
     steps:
       - uses: JuliaRegistries/TagBot@v1

.github/workflows/changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+on:
+  pull_request:
+
+jobs:
+  Check-Changelog:
+    name: Check Changelog Action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tarides/changelog-check-action@v3
+        with:
+          changelog: NEWS.md

.github/workflows/ci.yml

@@ -7,22 +7,33 @@ on:
 
 jobs:
   test:
-    name: Julia ${{ matrix.julia-version }} - ${{ matrix.os }}
+    name: Julia ${{ matrix.julia-version }} - ${{ matrix.group }} - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: [1.0, 1.4]
-        os: [ubuntu-latest, macOS-latest, windows-latest]
+        julia-version: ["lts", "1", "pre"]
+        os: [ubuntu-latest, macOS-latest]
+        group:
+          - 'test_manifolds'
+          - 'test_lie_groups'
+          #- 'test_integration'
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.julia-version }}
           arch: x64
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@latest
       - uses: julia-actions/julia-runtest@latest
+        env:
+          PYTHON: ""
+          MANIFOLDS_TEST_GROUP: ${{ matrix.group }}
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v5
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./lcov.info
+          name: codecov-umbrella
           fail_ci_if_error: false
-        if: ${{ matrix.julia-version == '1.4' && matrix.os =='ubuntu-latest' }}
+        if: ${{ matrix.os =='ubuntu-latest' }}

.github/workflows/clear_preview.yml

@@ -0,0 +1,26 @@
+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@v4
+        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 "documenter@juliadocs.github.io"
+              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/documenter.yml

@@ -9,12 +9,57 @@ jobs:
   docs:
     name: Documentation
     runs-on: ubuntu-latest
+    if: contains( github.event.pull_request.labels.*.name, 'preview docs') || github.ref == 'refs/heads/master' || contains(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+      - uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: "1.6.38"
       - uses: julia-actions/setup-julia@latest
         with:
-          version: 1.4
-      - uses: julia-actions/julia-docdeploy@releases/v1
+          version: "1.11"
+      - name: Julia Cache
+        uses: julia-actions/cache@v2
+      - name: Cache Quarto
+        id: cache-quarto
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-quarto
+        with:
+          path: tutorials/_freeze
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('tutorials/*.qmd') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+      - name: Cache Documenter
+        id: cache-documenter
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-documenter
+        with:
+          path: docs/src/tutorials
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('tutorials/*.qmd') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+      - name: Cache CondaPkg
+        id: cache-condaPkg
+        uses: actions/cache@v4
         env:
+          cache-name: cache-condapkg
+        with:
+          path: docs/.CondaPkg
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('docs/CondaPkg.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+      - name: "Documenter rendering (including Quarto)"
+        run: "docs/make.jl --quarto"
+        env:
+          PYTHON: ""
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+  note:
+    name: "Documentation deployment note."
+    runs-on: ubuntu-latest
+    if: "!contains( github.event.pull_request.labels.*.name, 'preview docs')"
+    steps:
+      - name: echo instructions
+        run: echo 'The Documentation is only generated and pushed on a PR if the “preview docs” label is added.'

.github/workflows/format.yml

@@ -10,33 +10,21 @@ jobs:
     name: "Format Check"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
-          version: 1.4
+          version: 1
+      - uses: julia-actions/cache@v2
       - name: Install JuliaFormatter and format
         run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia  -e 'using JuliaFormatter; format(
-              ".",
-              short_to_long_function_def = true,
-              always_for_in = true,
-              whitespace_ops_in_indices = true,
-              pipe_to_function_call = true,
-              import_to_using = true,
-              always_use_return = 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)
-          end'
+          using Pkg
+          Pkg.add(PackageSpec(name="JuliaFormatter", version="1"))
+          using JuliaFormatter
+          format("."; verbose=true)
+        shell: julia --color=yes {0}
+      - name: Suggest formatting changes
+        uses: reviewdog/action-suggester@v1
+        if: github.event_name == 'pull_request'
+        with:
+          tool_name: JuliaFormatter
+          fail_on_error: true

.gitignore

@@ -2,5 +2,17 @@ Manifest.toml
 docs/Manifest.toml
 docs/build
 docs/src/generated
+docs/src/misc/contributing.md
+docs/src/misc/CONTRIBUTING.md
+docs/src/misc/NEWS.md
 benchmark/tune.json
 benchmark/results*
+docs/src/tutorials/*.md
+.CondaPkg
+coverage
+*.cov
+tutorials/_freeze
+accuracy/*_files
+accuracy/_freeze
+accuracy/.quarto
+docs/src/tutorials/hand-gestures_files/figure-commonmark

.vale.ini

@@ -0,0 +1,19 @@
+StylesPath = docs/styles
+MinAlertLevel = warning
+Vocab = Manifolds
+
+MinAlertLevel = suggestion
+
+Packages = Google, write-good
+
+[*.md]
+BasedOnStyles = Vale, Google, write-good
+
+[NEWS.md, CONTRIBUTING.md]
+BasedOnStyles = Vale, Google
+Google.Will = false ; given format and really with intend a _will_
+Google.Headings = false ; some might jeally ahabe [] in their headers
+
+
+[*.jl]
+BasedOnStyles = Vale, Google, write-good