Housekeeping (#97)

* Housekeeping

* Fix lint errors

* Remove Linux builds

* Fix lint errors

* Fix failing integration test

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. ...
+2. ...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Platform (please complete the following information):**
+ - OS: [e.g. iOS 17.2, macOS 14.2]
+ - Device: [e.g. iPhone 15, MacBook Pro 16-inch 2021 M1 Pro]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/codeql/codeql-config.yml

@@ -0,0 +1,3 @@
+paths:
+  - Sources
+  - Tests

.github/workflows/ci-documentation.yml

@@ -0,0 +1,27 @@
+name: Documentation CI
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: "ci-documentation-${{ github.head_ref || github.run_id }}"
+  cancel-in-progress: true
+
+env:
+  DEVELOPER_DIR: /Applications/Xcode_15.2.app/Contents/Developer
+
+jobs:
+  build-documentation:
+    name: Build Documentation
+    runs-on: macos-14
+    env:
+      SWIFTCI_DOCC: 1
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build
+        run: swift package generate-documentation --product PoliceDataKit

.github/workflows/ci.yml

@@ -1,39 +1,31 @@
 name: CI
 
 on:
-  push:
+  pull_request:
     branches:
       - main
-  pull_request:
+  push:
     branches:
       - main
+    paths:
+      - ".github/workflows/ci.yml"
+      - "**/*.swift"
   workflow_dispatch:
 
 concurrency:
   group: "ci-${{ github.head_ref || github.run_id }}"
   cancel-in-progress: true
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_14.3.app/Contents/Developer
+  DEVELOPER_DIR: /Applications/Xcode_15.2.app/Contents/Developer
 
 jobs:
   build-test:
     name: Build and Test
-    runs-on: macos-13
+    runs-on: macos-14
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Cache SPM
-        uses: actions/cache@v3
-        with:
-          path: .build
-          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
-          restore-keys: |
-            ${{ runner.os }}-spm-
-      
-      - name: Lint
-        run: swiftlint --strict --reporter github-actions-logging
+        uses: actions/checkout@v4
 
       - name: Build
         run: swift build -Xswiftc -warnings-as-errors --build-tests
@@ -43,27 +35,26 @@ jobs:
 
       - name: Build for Release
         run: swift build -c release -Xswiftc -warnings-as-errors
-
-  build-documentation:
-    name: Build Documentation
-    runs-on: macos-13
+
+  build-and-test-platforms:
+    name: Build and Test (${{ matrix.name }})
+    runs-on: macos-14
+    continue-on-error: true
+    strategy:
+      matrix:
+        include:
+          - name: iOS
+            destination: platform=iOS Simulator,name=iPhone 15,OS=17.2
+          - name: watchOS
+            destination: platform=watchOS Simulator,name=Apple Watch Series 9 (45mm),OS=10.2
+          - name: tvOS
+            destination: platform=tvOS Simulator,name=Apple TV 4K (3rd generation),OS=17.2
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Cache SPM
-        uses: actions/cache@v3
-        with:
-          path: .build
-          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
-          restore-keys: |
-            ${{ runner.os }}-spm-
-
-      - name: Install markdownlint-cli
-        run: brew install markdownlint-cli
-
-      - name: Lint DocC files
-        run: markdownlint **/*.docc/**/*.md
+        uses: actions/checkout@v4
 
       - name: Build
-        run: swift package generate-documentation --product PoliceDataKit
+        run: set -o pipefail && env NSUnbufferedIO=YES && xcodebuild build-for-testing -scheme PoliceDataKit -only-testing PoliceDataKitTests -destination '${{ matrix.destination }}' | xcpretty
+
+      - name: Test
+        run: set -o pipefail && env NSUnbufferedIO=YES && xcodebuild test-without-building -scheme PoliceDataKit -only-testing PoliceDataKitTests -destination '${{ matrix.destination }}' | xcpretty

.github/workflows/codeql.yml

@@ -0,0 +1,47 @@
+name: CodeQL
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    # Every Sunday at 12am
+    - cron:  '0 0 * * 0'
+  workflow_dispatch:
+
+concurrency:
+  group: "codeql-${{ github.head_ref || github.run_id }}"
+  cancel-in-progress: true
+
+env:
+  DEVELOPER_DIR: /Applications/Xcode_15.2.app/Contents/Developer
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: macos-14
+    timeout-minutes: 120
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: swift
+          config-file: ./.github/codeql/codeql-config.yml
+
+      - name: Build
+        run: swift build --build-tests 
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:swift"

.github/workflows/documentation.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches:
       - main
+    paths:
+      - ".github/workflows/documentation.yml"
+      - "**/*.swift"
+      - "**/*.docc/**/*.md"
   workflow_dispatch:
 
 permissions:
@@ -12,33 +16,20 @@ permissions:
   id-token: write
 
 concurrency:
-  group: "documentation"
-  cancel-in-progress: false
-
-env:
-  DEVELOPER_DIR: /Applications/Xcode_14.3.app/Contents/Developer
+  group: "deploy-documentation"
+  cancel-in-progress: true
 
 jobs:
-  deploy:
-    name: Deploy Documentation
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}documentation/policedatakit
-    runs-on: macos-13
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    container: swift:5.9.2-jammy
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Pages
-        uses: actions/configure-pages@v3
-
-      - name: Cache SPM
-        uses: actions/cache@v3
-        with:
-          path: .build
-          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
-          restore-keys: |
-            ${{ runner.os }}-spm-
+        uses: actions/configure-pages@v4
 
       - name: Build documentation
         run: |
@@ -48,12 +39,22 @@ jobs:
           --transform-for-static-hosting \
           --hosting-base-path police-data-kit \
           --output-path docs
+        env:
+          SWIFTCI_DOCC: 1
 
       - name: Upload documentation
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: 'docs'
-
+
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}documentation/policedatakit
+    steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@main
+        uses: actions/deploy-pages@v4

.github/workflows/integration.yml

@@ -4,33 +4,31 @@ on:
   pull_request:
     branches:
       - main
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/integration.yml"
+      - "**/*.swift"
   schedule:
-    # Every day at 12am
-    - cron:  '0 0 * * *'
+    # Every Sunday at 12am
+    - cron:  '0 0 * * 0'
   workflow_dispatch:
 
 concurrency:
   group: "integration-${{ github.head_ref || github.run_id }}"
   cancel-in-progress: true
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_14.3.app/Contents/Developer
+  DEVELOPER_DIR: /Applications/Xcode_15.2.app/Contents/Developer
 
 jobs:
   integration-test:
     name: Integration Test
-    runs-on: macos-13
+    runs-on: macos-14
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Cache SPM
-        uses: actions/cache@v3
-        with:
-          path: .build
-          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
-          restore-keys: |
-            ${{ runner.os }}-spm-
+        uses: actions/checkout@v4
 
       - name: Build
         run: swift build --build-tests