Merge pull request #1 from ISISComputingGroup/initial

Initial

Author: rerpha

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build-nightly.yml

@@ -0,0 +1,9 @@
+name: Nightly build
+on:
+  schedule:
+    - cron: "51 3 * * *"
+  workflow_dispatch:
+
+jobs:
+  nightly-build:
+    uses: ./.github/workflows/build.yml

.github/workflows/build.yml

@@ -0,0 +1,103 @@
+name: Build
+on: [push, workflow_call]
+
+permissions:
+  contents: write
+
+jobs:
+  lint:
+    runs-on: "windows-latest"
+    steps:
+      - uses: actions/checkout@v4
+      - name: install stable rust
+        run: rustup install stable
+      - uses: Swatinem/rust-cache@v2
+      - name: Format check
+        run: cargo fmt --check
+      - name: Clippy
+        run: cargo clippy -- --deny warnings
+  docs:
+    runs-on: "windows-latest"
+    steps:
+      - uses: actions/checkout@v4
+      - name: install stable rust
+        run: rustup install stable
+      - uses: Swatinem/rust-cache@v2
+      - name: Build docs
+        run: cargo doc --no-deps
+      - name: Generate index.html
+        shell: cmd
+        # u wot?
+        run: |
+          echo|set /p="<meta http-equiv="refresh" content="0; url=ick/">" > target/doc/index.html
+          exit /B 0
+      - name: Upload artifacts (docs)
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            target/doc
+          if-no-files-found: error
+          retention-days: 1
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/initial' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: target/doc
+          force_orphan: true
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ "ubuntu-latest", "windows-latest" ]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - name: install stable rust
+        run: rustup install stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: ${{ matrix.os }}
+      - name: Unit tests
+        run: cargo test
+      - name: Unit tests (release mode)
+        run: cargo test --release
+      - name: Build (debug)
+        run: cargo build
+      - name: Build (release)
+        run: cargo build --release
+      - name: Upload artifacts (debug)
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ format('debug-{0}', matrix.os) }}
+          path: |
+            target/debug/ick
+            target/debug/ick.exe
+            target/debug/ick.pdb
+          if-no-files-found: error
+          retention-days: 1
+      - name: Upload artifacts (release)
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ format('release-{0}', matrix.os) }}
+          path: |
+            target/release/ick
+            target/release/ick.exe
+            target/release/ick.pdb
+          if-no-files-found: error
+          retention-days: 1
+  results:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: Final Results
+    needs: [tests, lint, docs]
+    steps:
+    - run: exit 1
+      # see https://stackoverflow.com/a/67532120/4907315
+      if: >-
+          ${{
+               contains(needs.*.result, 'failure')
+            || contains(needs.*.result, 'cancelled')
+          }}

.gitignore

@@ -0,0 +1,17 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug
+target
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Generated by cargo mutants
+# Contains mutation testing data
+**/mutants.out*/
+
+# RustRover
+.idea/