Maintenance July 30th, 2024 (#907)

* Maintenance July 30th, 2024 * commented pipeline * commented pipeline * fix quoting
mbround18 · Jul 31, 2024 · cf6f3cb · cf6f3cb
1 parent c383a77
commit cf6f3cb
Show file tree

Hide file tree

Showing 14 changed files with 332 additions and 254 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -3,9 +3,7 @@
   "projectOwner": "mbround18",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "files": [
-    "README.md"
-  ],
+  "files": ["README.md"],
   "imageSize": 100,
   "commit": true,
   "commitConvention": "eslint",
@@ -15,140 +13,105 @@
       "name": "Mark",
       "avatar_url": "https://avatars.githubusercontent.com/u/3298808?v=4",
       "profile": "http://arneman.me/",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "mbround18",
       "name": "Michael",
       "avatar_url": "https://avatars.githubusercontent.com/u/12646562?v=4",
       "profile": "https://m.bruno.fyi/",
-      "contributions": [
-        "infra",
-        "code",
-        "doc"
-      ]
+      "contributions": ["infra", "code", "doc"]
     },
     {
       "login": "imgbot[bot]",
       "name": "imgbot[bot]",
       "avatar_url": "https://avatars.githubusercontent.com/in/4706?v=4",
       "profile": "https://github.com/apps/imgbot",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "AGhost-7",
       "name": "Jonathan Boudreau",
       "avatar_url": "https://avatars.githubusercontent.com/u/6957411?v=4",
       "profile": "https://github.com/AGhost-7",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
     },
     {
       "login": "Kellei2983",
       "name": "Lukáš Hruška",
       "avatar_url": "https://avatars.githubusercontent.com/u/32897629?v=4",
       "profile": "https://github.com/Kellei2983",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "JulianVallee",
       "name": "Julian Vallée",
       "avatar_url": "https://avatars.githubusercontent.com/u/6720458?v=4",
       "profile": "http://vallee-design.de/",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
     },
     {
       "login": "Finomnis",
       "name": "Finomnis",
       "avatar_url": "https://avatars.githubusercontent.com/u/3129043?v=4",
       "profile": "https://github.com/Finomnis",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
     },
     {
       "login": "JustinByrne",
       "name": "Justin Byrne",
       "avatar_url": "https://avatars.githubusercontent.com/u/14056930?v=4",
       "profile": "https://tech.jrlbyrne.com/",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "apeabody",
       "name": "Andrew Peabody",
       "avatar_url": "https://avatars.githubusercontent.com/u/14035345?v=4",
       "profile": "http://blog.andrewpeabody.com/",
-      "contributions": [
-        "doc",
-        "code"
-      ]
+      "contributions": ["doc", "code"]
     },
     {
       "login": "morales2k",
       "name": "Jorge Morales",
       "avatar_url": "https://avatars.githubusercontent.com/u/1074855?v=4",
       "profile": "https://github.com/morales2k",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
     },
     {
       "login": "spannerman79",
       "name": "Spanner_Man",
       "avatar_url": "https://avatars.githubusercontent.com/u/7542384?v=4",
       "profile": "https://github.com/spannerman79",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "cameronwp",
       "name": "Cameron Pittman",
       "avatar_url": "https://avatars.githubusercontent.com/u/5186335?v=4",
       "profile": "https://hurtlingthrough.space/",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "kodiakhq[bot]",
       "name": "kodiakhq[bot]",
       "avatar_url": "https://avatars.githubusercontent.com/in/29196?v=4",
       "profile": "https://github.com/apps/kodiakhq",
-      "contributions": [
-        "infra",
-        "doc",
-        "code"
-      ]
+      "contributions": ["infra", "doc", "code"]
     },
     {
       "login": "andjo",
       "name": "Anders Johansson",
       "avatar_url": "https://avatars.githubusercontent.com/u/665563?v=4",
       "profile": "https://github.com/andjo",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     },
     {
       "login": "ImgBotApp",
       "name": "Imgbot",
       "avatar_url": "https://avatars.githubusercontent.com/u/31427850?v=4",
       "profile": "https://imgbot.net/",
-      "contributions": [
-        "doc"
-      ]
+      "contributions": ["doc"]
     }
   ],
   "contributorsPerLine": 7

diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml
@@ -24,9 +24,10 @@ jobs:
     steps:
       - uses: actions/setup-node@v4
       - uses: actions/checkout@v4
-      - run: |
-          npx -y prettier --check ./
-  #          npx -y shellcheck ./.github/scripts/*.sh ./src/scripts/*.sh
+      - run: npx -y prettier --check ./
+      # Uncomment the line below to include shell script linting
+      # - run: npx -y shellcheck ./.github/scripts/*.sh ./src/scripts/*.sh
+
   step_summary_meta:
     runs-on: ubuntu-latest
     steps:
@@ -38,8 +39,6 @@ jobs:
             echo "> These are development images, expect bugs!!"
           fi
 
-  # Run tests.
-  # See also https://docs.docker.com/docker-hub/builds/automated-testing/
   build:
     runs-on: ubuntu-latest
     strategy:
@@ -53,7 +52,7 @@ jobs:
           - image: valheim
             push: ${{ contains(github.event.pull_request.labels.*.name, 'canary') }}
     steps:
-      - uses: actions/checkout@v4 # v4
+      - uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
@@ -68,11 +67,8 @@ jobs:
         id: meta
         uses: crazy-max/ghaction-docker-meta@v5
         with:
-          # list of Docker images to use as base name for tags
           images: |
             mbround18/${{ matrix.image }}
-
-          # generate Docker tags based on the following events/attributes
           tags: |
             type=sha
 

diff --git a/.github/workflows/docker-release.yml b/.github/workflows/docker-release.yml
@@ -18,18 +18,17 @@ jobs:
         image: [odin, valheim]
 
     steps:
-      - uses: actions/checkout@v4 # v4
+      # Check out the repository
+      - uses: actions/checkout@v4
 
+      # Generate Docker metadata
       - name: Docker meta
         id: meta
         uses: crazy-max/ghaction-docker-meta@v5
         with:
-          # list of Docker images to use as base name for tags
           images: |
             mbround18/${{ matrix.image }}
             ghcr.io/mbround18/${{ matrix.image }}
-
-          # generate Docker tags based on the following events/attributes
           tags: |
             type=schedule
             type=ref,event=branch
@@ -39,15 +38,18 @@ jobs:
             type=semver,pattern={{major}}
             type=sha
 
+      # Set up Docker Buildx
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
+      # Log in to DockerHub
       - name: Login to DockerHub
         uses: docker/login-action@v3
         with:
           username: mbround18
           password: ${{ secrets.DOCKER_TOKEN }}
 
+      # Log in to GitHub Container Registry
       - name: Login to GitHub Container Registry
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
@@ -56,15 +58,11 @@ jobs:
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GHCR_TOKEN }}
 
+      # Install jq for JSON parsing
       - name: "JQ: Install"
-        run: |
-          sudo apt-get install -y jq
-
-      - name: "Cargo Make: Get Latest Version"
-        id: cargo-make
-        run: |
-          echo "version=$(curl -s https://api.github.com/repos/sagiegurari/cargo-make/releases/latest | jq -r '.tag_name')" >> $GITHUB_OUTPUT
+        run: sudo apt-get install -y jq
 
+      # Build and push Docker images
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
@@ -79,4 +77,3 @@ jobs:
             "GITHUB_SHA=${GITHUB_SHA}"
             "GITHUB_REF=${GITHUB_REF}"
             "GITHUB_REPOSITORY=${GITHUB_REPOSITORY}"
-            "CARGO_MAKE_VERSION=${{ steps.cargo-make.outputs.version }}"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -15,17 +15,19 @@ jobs:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
     steps:
-      - uses: actions/checkout@v4 # v4
+      # Check out the repository
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          token: ${{ secrets.GH_TOKEN }}
 
-      - name: Setup | Rust | Nightly
+      # Set up Rust with the stable toolchain
+      - name: Setup | Rust | Stable
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           toolchain: stable
           components: clippy rustfmt
 
+      # Cache Cargo build files to speed up builds
       - uses: actions/cache@v4
         name: Cache Cargo Files
         with:
@@ -34,14 +36,17 @@ jobs:
             target/debug
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}
 
+      # Build the project with the release profile
       - name: Build Release
         run: make release PROFILE=production
 
+      # Create a ZIP archive of the release binaries
       - uses: vimtor/action-zip@v1
         with:
           files: target/release/odin target/release/huginn
           dest: tmp/bundle.zip
 
+      # Use the Auto Release Tool by Intuit
       - name: Auto Release Tool by Intuit
         uses: mbround18/[email protected]
         with:

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -15,17 +15,21 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build-nd-test:
+  build-and-test:
     name: Build & Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4 # v4
-      - name: Setup | Rust | Nightly
+      # Check out the repository
+      - uses: actions/checkout@v4
+
+      # Set up Rust with the stable toolchain
+      - name: Setup | Rust | Stable
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           toolchain: stable
           components: clippy rustfmt
 
+      # Cache Cargo build files to speed up builds
       - uses: actions/cache@v4
         name: Cache Cargo Files
         with:
@@ -34,9 +38,14 @@ jobs:
             target/debug
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}
 
+      # Build the Rust project
       - name: Build
         run: cargo build --verbose
+
+      # Run tests
       - name: Run tests
         run: cargo test --verbose
+
+      # Check formatting
       - name: Lint
         run: cargo fmt -- --check