[bot] synced file(s) with Wall-Brew-Co/rebroadcast (#126)

* [bot] synced local '.cljstyle' with remote 'sources/clojure/.cljstyle' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.clj-kondo/config.edn' with remote 'sources/clojure/cljkondo/config.edn' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/PULL_REQUEST_TEMPLATE.md' with remote 'sources/github-actions/PULL_REQUEST_TEMPLATE.md' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/label.yml' with remote 'sources/github-actions/workflows/label.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/sync_labels.yml' with remote 'sources/github-actions/workflows/sync_labels.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/todo.yml' with remote 'sources/github-actions/workflows/todo.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/contributors.yml' with remote 'sources/github-actions/workflows/contributors.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/greetings.yml' with remote 'sources/github-actions/workflows/greetings.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/clojure.yml' with remote 'sources/github-actions/workflows/clojure.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/deploy_to_clojars.yml' with remote 'sources/github-actions/workflows/deploy_to_clojars.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/format.yml' with remote 'sources/github-actions/workflows/format.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/lint.yml' with remote 'sources/github-actions/workflows/lint.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/scanner.yml' with remote 'sources/github-actions/workflows/scanner.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local '.github/workflows/cljdoc_test.yml' with remote 'sources/github-actions/workflows/cljdoc_test.yml' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast * [bot] synced local 'LICENSE' with remote 'sources/templates/LICENSE' Sourced from: https://github.com/Wall-Brew-Co/rebroadcast
Wall-Brew-Co · Oct 8, 2024 · 75961e7 · 75961e7
1 parent 6fd297e
commit 75961e7
Show file tree

Hide file tree

Showing 15 changed files with 183 additions and 100 deletions.
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.edn
@@ -37,7 +37,8 @@
                  :refer-all                             {:exclude #{clojure.test}}
                  :shadowed-var                          {:level :warning}
                  :single-key-in                         {:level :warning}
-                 :unresolved-symbol                     {:exclude [(clojure.test/is [match?])
+                 :unresolved-symbol                     {:exclude [clojure.core/*clojure-version*
+                                                                   (clojure.test/is [match?])
                                                                    clojure.test.check.clojure-test/defspec]}
                  :unsorted-required-namespaces          {:level :warning}
                  :used-underscored-binding              {:level :warning}

diff --git a/.cljstyle b/.cljstyle
@@ -1,6 +1,6 @@
 {:files {:extensions #{"clj" "cljs" "cljc" "cljx" "edn"}
          :ignore     #{"target" ".git" ".idea" ".vscode" "node_modules" ".clj-kondo" ".calva" ".lsp"}}
  :rules {:namespaces  {:enabled? false}
-         :indentation {:indents {#"defspec"              [[:inner 0]]
-                                 #"defstate"             [[:inner 0]]
-                                 #"for-all"              [[:inner 0]]}}}}
+         :indentation {:indents {#"defspec"  [[:inner 0]]
+                                 #"defstate" [[:inner 0]]
+                                 #"for-all"  [[:inner 0]]}}}}
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,12 +4,21 @@ Quickly describe your change and the rationale behind it.
 Please link to any relevant issues or discussions.
 
 - Additions:
-- Updates:
-- Deletions:
+  - { change }
+- Changes:
+  - { change }
+- Deprecations:
+  - { change }
+- Removals:
+  - { change }
+- Fixes:
+  - { change }
+- Security:
+  - { change }
 
 ## Pre-merge Checklist
 
 - [ ] Read and agree to the Contribution Guidelines and Code of Conduct
-- [ ] Write new tests for the changed functionality
-- [ ] Update CHANGELOG and increment version
-- [ ] Update README and relevant documentation
+- [ ] Write new tests for impacted functionality
+- [ ] Update the CHANGELOG and increment version
+- [ ] Update the README and other relevant documentation
diff --git a/.github/workflows/cljdoc_test.yml b/.github/workflows/cljdoc_test.yml
@@ -1,31 +1,39 @@
+# Verifies that the project is compatible with cljdoc, and that our documentation will render correctly.
 name: Check cljdoc compatibility
 
 on: ["pull_request", "workflow_dispatch"]
 
 jobs:
   check-cljdoc:
+
+    # Cancel any runs in progress for the same workflow and PR
     concurrency:
       group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
       cancel-in-progress: true
+
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/[email protected]
+      - name: Checkout Repository
+        id: checkout
+        uses: actions/[email protected]
 
-      - name: Cache maven dependencies
+      - name: Cache Maven Dependencies
+        id: cache-maven
         uses: actions/cache@v4
         env:
           cache-name: cache-maven
         with:
           path: ~/.m2
-          save-always: true
           key: ${{ runner.os }}-clj-${{ hashFiles('**/project.clj') }}
           restore-keys: |
             ${{ runner.os }}-clj
 
-      - name: Package the library as a jar
+      - name: Package The Library As A Jar
+        id: package
         run: lein jar
 
       - name: cljdoc Check
+        id: cljdoc-check
         uses: cljdoc/[email protected]
 
 # This file was automatically copied and populated by rebroadcast

diff --git a/.github/workflows/clojure.yml b/.github/workflows/clojure.yml
@@ -1,36 +1,41 @@
+# Execute Clojure tests using Leiningen
 name: Clojure Tests
 
 on: ["workflow_dispatch", "pull_request"]
 
 jobs:
   test:
 
+    # Cancel any runs in progress for the same workflow and PR
     concurrency:
       group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
       cancel-in-progress: true
 
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout Repository
-      uses: actions/[email protected]
-
-    - name: Cache maven dependencies
-      uses: actions/cache@v4
-      env:
+      - name: Checkout Repository
+        id: checkout
+        uses: actions/[email protected]
+
+      - name: Cache Maven Dependencies
+        id: cache-maven
+        uses: actions/cache@v4
+        env:
           cache-name: cache-maven
-      with:
+        with:
           path: ~/.m2
-          save-always: true
           key: ${{ runner.os }}-clj-${{ hashFiles('**/project.clj') }}
           restore-keys: |
             ${{ runner.os }}-clj
 
-    - name: Install Clojure dependencies
-      run: lein deps
+      - name: Install Clojure Dependencies
+        id: install-deps
+        run: lein deps
 
-    - name: Run all tests
-      run: lein test
+      - name: Run All Tests
+        id: run-tests
+        run: lein test
 
 # This file was automatically copied and populated by rebroadcast
 # Do not edit this file directly, instead modify the source at https://github.com/Wall-Brew-Co/rebroadcast/blob/master/sources/github-actions/workflows/clojure.yml
diff --git a/.github/workflows/contributors.yml b/.github/workflows/contributors.yml
@@ -1,3 +1,5 @@
+# This file is used to generate the contributors image for each repository.
+# Repos with more than 2 non-member, non-bot contributors should link this image in their README.
 name: Generate Contributors Image
 on:
   schedule:
@@ -13,7 +15,9 @@ jobs:
     if: github.repository_owner == 'Wall-Brew-Co'
     runs-on: ubuntu-latest
     steps:
-      - uses: wow-actions/contributors-list@v1
+      - name: Generate Contributors Image
+        id: contributors
+        uses: wow-actions/contributors-list@v1
         with:
           GITHUB_TOKEN: ${{ secrets.WALL_BREW_BOT_PAT }}
           svgPath: CONTRIBUTORS.svg

diff --git a/.github/workflows/deploy_to_clojars.yml b/.github/workflows/deploy_to_clojars.yml
@@ -1,3 +1,5 @@
+# Deploy the cuurent project to Clojars
+# All deployments use the Wall Brew Bot user
 name: Deploy to Clojars
 
 on:
@@ -12,50 +14,65 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout Repository
-      uses: actions/[email protected]
+      - name: Checkout Repository
+        id: checkout
+        uses: actions/[email protected]
 
-    - name: Cache maven dependencies
-      uses: actions/cache@v4
-      env:
+      - name: Cache Maven Dependencies
+        id: cache-maven
+        uses: actions/cache@v4
+        env:
           cache-name: cache-maven
-      with:
+        with:
           path: ~/.m2
-          save-always: true
           key: ${{ runner.os }}-clj-${{ hashFiles('**/project.clj') }}
           restore-keys: |
             ${{ runner.os }}-clj
 
-    - name: Install Clojure dependencies
-      run: lein deps
+      - name: Install Clojure Dependencies
+        id: install-deps
+        run: lein deps
 
-    - name: Validate Changelog Status
-      run: lein sealog check
+      # This isn't strictly required to deploy, but is a quality check against our documentation
+      - name: Validate Changelog Status
+        id: validate-changelog
+        run: lein sealog check
 
-    - name: Display Version
-      run: lein sealog version
+      # This helps us ensure that we are deploying the correct version
+      - name: Display Version
+        id: display-version
+        run: lein sealog version
 
-    - name: Run sanity tests
-      run: lein test
+      # This is a sanity check to ensure that the project is in a good state
+      - name: Run Sanity Tests
+        id: sanity-test
+        run: lein test
 
-    - name: Run build test
-      run: lein jar
+      # Compile the project into a jar file
+      # This is the file that will be deployed to Clojars and is the final gate before deployment
+      - name: Run Build Test
+        id: build-test
+        run: lein jar
 
-    - name: Publish to Clojars
-      env:
-        CLOJARS_USER: ${{ secrets.CLOJARS_USER }}
-        CLOJARS_PASS: ${{ secrets.CLOJARS_PASS }}
-      run: lein deploy clojars
+      - name: Publish To Clojars
+        id: publish
+        env:
+          CLOJARS_USER: ${{ secrets.CLOJARS_USER }}
+          CLOJARS_PASS: ${{ secrets.CLOJARS_PASS }}
+        run: lein deploy clojars
 
-    - name: Resolve version
-      id: versionchk
-      run: echo "VERSION=$(lein sealog version project.clj | tail -n 1)" >> $GITHUB_OUTPUT
+      - name: Resolve version
+        id: versionchk
+        run: echo "VERSION=$(lein sealog version project.clj | tail -n 1)" >> $GITHUB_OUTPUT
 
-    - name: Push Tag
-      uses: hole19/[email protected]
-      env:
-        TAG: v${{ steps.versionchk.outputs.VERSION }}
-        GITHUB_TOKEN: ${{ secrets.WALL_BREW_BOT_PAT }}
+      # Push a tag to the repository to mark the version
+      # This also helps Renovate locate Change Notes for dependency update PRs
+      - name: Push Tag
+        id: push-tag
+        uses: hole19/[email protected]
+        env:
+          TAG: v${{ steps.versionchk.outputs.VERSION }}
+          GITHUB_TOKEN: ${{ secrets.WALL_BREW_BOT_PAT }}
 
 # This file was automatically copied and populated by rebroadcast
 # Do not edit this file directly, instead modify the source at https://github.com/Wall-Brew-Co/rebroadcast/blob/master/sources/github-actions/workflows/deploy_to_clojars.yml
diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -1,3 +1,5 @@
+# Automatically format clojure code using cljstyle
+# For more information, please visit: https://github.com/Wall-Brew-Co/open-source/blob/master/README.md#automating-opinions
 name: Formatter
 
 on: [pull_request]
@@ -10,22 +12,28 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: git checkout
+      # Checkout the repository with our Wall Brew Bot Token
+      # We need this so any changes can be committed back to the repository
+      - name: Checkout Repository
+        id: checkout
         uses: actions/[email protected]
         with:
           ref: ${{ github.head_ref }}
           token: ${{ secrets.WALL_BREW_BOT_PAT }}
 
       - name: Install cljstyle
+        id: install-cljstyle
         uses: just-sultanov/setup-cljstyle@v1
         with:
           version: '0.14.0'
 
-      - name: Format Clojure code
+      - name: Format Clojure Code
+        id: format
         run: |
           cljstyle fix --report --report-timing --verbose
 
-      - name: Commit changes
+      - name: Commit Changes
+        id: commit
         uses: stefanzweifel/[email protected]
         with:
           commit_message: |

diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
@@ -1,3 +1,4 @@
+# Greet new contributors on their first interaction with the repository
 name: Greetings
 
 on: [pull_request, issues]
@@ -8,11 +9,13 @@ jobs:
     if: github.repository_owner == 'Wall-Brew-Co'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/first-interaction@v1
-      with:
-        repo-token: ${{ secrets.WALL_BREW_BOT_PAT }}
-        issue-message: 'Thank you for taking the time to let us know!'
-        pr-message: 'Congratulations! This is your first contribution!'
+      - name: Greet New Contributors
+        id: greet
+        uses: actions/first-interaction@v1
+        with:
+          repo-token: ${{ secrets.WALL_BREW_BOT_PAT }}
+          issue-message: 'Thank you for taking the time to let us know!'
+          pr-message: 'Congratulations! This is your first contribution!'
 
 # This file was automatically copied and populated by rebroadcast
 # Do not edit this file directly, instead modify the source at https://github.com/Wall-Brew-Co/rebroadcast/blob/master/sources/github-actions/workflows/greetings.yml
diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml
@@ -1,3 +1,4 @@
+# Apply GitHub Labels to Pull Requests
 name: Label Pull Requests
 
 on: [pull_request]
@@ -10,9 +11,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/labeler@v5
-      with:
-        repo-token: "${{ secrets.WALL_BREW_BOT_PAT }}"
+      - name: Label Pull Requests
+        id: label
+        uses: actions/labeler@v5
+        with:
+          repo-token: "${{ secrets.WALL_BREW_BOT_PAT }}"
 
 # This file was automatically copied and populated by rebroadcast
 # Do not edit this file directly, instead modify the source at https://github.com/Wall-Brew-Co/rebroadcast/blob/master/sources/github-actions/workflows/label.yml