Version 0.25.0: Rework CI and Contributions

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,25 +1,23 @@
----
-name: PR to master
-about: Merging development into master
-title: 'Version $VERSION: $DESCRIPTION'
-labels: needs-labeling
-assignees: ''
+If you are merging to a non-`master` branch, I assume you know what you are doing. Most PRs should be made to `master`.
 
----
+If you are merging to `master`, you have two options: explicitly say that these changes constitute a "new version" (you probably don't want to do that, and I will walk you through it if that is what you should be doing), or just merge your changes in to `master` and they will be released when I determine it is time for a new version.
+
+Assuming you are not merging as a new version:
+1. Fill in the list below with your changes, referring to issues when appropriate (https://docs.github.com/articles/closing-issues-using-keywords).
+1. Fill in any information you want to share, if you have any. Otherwise, remove that line.
+1. Change the task list below to contain any tasks you need to complete before this PR can be merged.
+1. You can now delete these instructions, so that "Here's what's new" is the first line of your PR body.
 
 Here's what's new:
 - A
 - List
 - Of
 - Items
 
+Any other information you want to share here
+
 Here's what has to happen:
 - [ ] Anything
 - [ ] Specific
 - [ ] This
 - [ ] PR
-- [ ] Ensure the changelog has everything new that is being added
-- [ ] Bump version (run `updateVersion.sh`)
-1. Wait for CI
-1. Merge
-1. Run `release.sh`

.github/workflows/danger.yml

@@ -0,0 +1,17 @@
+name: danger
+
+# Controls when the action will run. This action runs Danger, so run on PRs only
+on: pull_request
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  test:
+    name: Run Danger
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: danger/swift@3.12.3
+        with:
+          args: --use-github-checks --verbose
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploydocs.yml

@@ -0,0 +1,61 @@
+name: Deploy
+
+on:
+  push:
+    tags: 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  deploy-docs:
+    name: Deploy Docs
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: swift-actions/setup-swift@v1
+    - run: swift --version
+    - name: Install jazzy
+      run: gem install jazzy
+    - name: Run jazzy
+      run: jazzy -o newdocs
+    - name: Checkout gh-pages
+      uses: actions/checkout@v3
+      with:
+        ref: gh-pages
+        path: ghp
+    - name: Determine VERSION
+      run: echo 'VERSION=${GITHUB_REF:#refs/tags/v}' >> $GITHUB_ENV #lops of that part from the beginning of the string, could be ${GITHUB_REF:11} to chop off 11 characters
+    - name: Process docs
+      run: |
+        mkdir ghp/docs/v$VERSION
+        mv newdocs/* ghpd/docs/v$VERSION
+        cd ghp
+        echo 'section > section > p > img { margin-top: 4em; margin-right: 2em; }' >> docs/v$VERSION/css/jazzy.css
+        bash ../scripts/updateLatestDocs.sh $VERSION
+        cd ..
+    - name: Push updated docs
+      run: |
+        cd ghp
+        git config user.name github-actions
+        git config user.email github-actions@github.com
+        git add .
+        git commit -m "Add documentation for version $VERSION"
+        git push
+  deploy-release:
+    name: Deploy Release
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Determine VERSION
+      run: echo 'VERSION=${GITHUB_REF:#refs/tags/v}' >> $GITHUB_ENV #lops of that part from the beginning of the string, could be ${GITHUB_REF:11} to chop off 11 characters
+    - name: Determine release name
+      run: |
+        NAME=$(git tag -l --format='%(contents)' v$VERSION | head -n 1)
+        echo "NAME='$NAME'" >> $GITHUB_ENV
+        echo "Determined release name as '$NAME'" >> $GITHUB_STEP_SUMMARY
+    - name: Determine release body (from CHANGELOG)
+      run: cat CHANGELOG.md | sed '1,/^## /d' | sed '1,/^## /d' | sed '/^## /,$d' | tee body.md
+    - uses: ncipollo/release-action@v1.10.0
+      with:
+        name: ${{ env.NAME }}
+        bodyFile: "body.md"
+        draft: true
+        prerelease: true

.github/workflows/test.yml

@@ -0,0 +1,62 @@
+name: tests
+
+# Controls when the action will run. Since this action runs only tests, run on pushes and PRs
+on: [push, pull_request]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  test:
+    name: Test Swift ${{ matrix.swift }}.x on ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-10.15, macos-11, macos-12, ubuntu-18.04, ubuntu-20.04, ubuntu-22.04]
+        #os: [macos-10.15, macos-11, macos-12, ubuntu-18.04, ubuntu-20.04]
+        swift: ["4.2", "5.0", "5.1", "5.2", "5.3", "5.4", "5.5", "5.6"] #setup-swift finds the latest bug fix version
+        exclude:
+          - os: macos-10.15
+            swift: "4.2"
+          - os: macos-10.15
+            swift: "5.1"
+          - os: macos-10.15
+            swift: "5.2"
+          - os: macos-11 #the vast majority of these fail, so we exclude the OS and include the specific Swift versions
+          - os: macos-12
+          - os: ubuntu-20.04
+            swift: "4.2"
+          - os: ubuntu-20.04
+            swift: "5.0"
+          - os: ubuntu-20.04
+            swift: "5.1"
+          - os: ubuntu-22.04 #Not supported by setup-swift
+        include:
+          - os: macos-11
+            swift: "5.5"
+          - os: macos-11
+            swift: "5.6"
+          - os: macos-12
+            swift: "5.5"
+          - os: macos-12
+            swift: "5.6"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: swift-actions/setup-swift@v1
+        with:
+          swift-version: ${{ matrix.swift }}
+      - run: |
+          swift --version
+          echo "Using \`$(swift --version | head -n 1)\`" >> $GITHUB_STEP_SUMMARY
+      - run: swift test --parallel --xunit-output output.xml
+        if: startsWith(matrix.os, 'ubuntu')
+      - run: swift test
+        if: startsWith(matrix.os, 'macos')
+      - uses: test-summary/action@v1
+        if: always() && startsWith(matrix.os, 'ubuntu')
+        with:
+          paths: output.xml
+          show: fail #none | all | (fail)?,(pass)?,(skip)?
+      - run: 'echo ":white_check_mark: Tests succeeded!" >> $GITHUB_STEP_SUMMARY'
+        if: ${{ success() && startsWith(matrix.os, 'macos') }}
+      - run: 'echo ":x: Some tests failing!" >> $GITHUB_STEP_SUMMARY' #perhaps :heavy_exclamation_mark:
+        if: ${{ failure() && startsWith(matrix.os, 'macos') }}

.jazzy.yaml

@@ -2,7 +2,7 @@ clean: true
 author: Samasaur
 author_url: https://github.com/Samasaur1
 module: DiceKit
-module_version: 0.24.1
+module_version: 0.25.0
 # docset_icon:
 github_url: https://github.com/Samasaur1/DiceKit
 # github_file_prefix:
@@ -27,4 +27,4 @@ custom_categories:
    - Chances
    - Chance
    - Caching
-   - ENABLE_CACHING
+   - ENABLE_CACHING