build: enable cloning private repos

Author: OliverNChalk

.github/workflows/actions/checkout/action.yaml

@@ -0,0 +1,27 @@
+name: checkout
+description: "Checks out repo with optional token"
+inputs:
+  token:
+    description: "Access token for private repos"
+    required: false
+
+runs:
+  using: "composite"
+  steps:
+    - id: get-toolchain
+      shell: bash
+      run: |
+        USER_OVERRIDE=${{ inputs.toolchain }}
+        DEFAULT_TOOLCHAIN=$(grep channel rust-toolchain.toml | awk '{print $3}' | sed 's/"//g')
+        TOOLCHAIN=${USER_OVERRIDE:-$DEFAULT_TOOLCHAIN}
+        echo "toolchain=$TOOLCHAIN" >> $GITHUB_OUTPUT
+
+    - uses: actions/checkout@v3
+      if: "${{ inputs.token != null }}"
+      with:
+        token: ${{ secrets.CI_READ }}
+        submodules: recursive
+    - uses: actions/checkout@v3
+      if: "${{ inputs.token == null }}"
+      with:
+        submodules: recursive

.github/workflows/actions/rust-toolchain/action.yml

@@ -1,8 +1,12 @@
 name: rust-toolchain
+description: "Sets up a standard rust toolchain"
 inputs:
   toolchain:
     description: "Which rust toolchain to use"
     required: false
+  token:
+    description: "Access token for private repos"
+    required: false
 
 runs:
   using: "composite"
@@ -23,3 +27,9 @@ runs:
     - uses: Swatinem/[email protected]
       with:
         shared-key: ${{ steps.get-toolchain.outputs.toolchain }}
+    - run: git config --global url."https://x-access-token:${{ inputs.token }}@github.com/".insteadOf "https://github.com/"
+      if: ${{ inputs.token != null }}
+      shell: bash
+    - run: git config --global url."https://${{ inputs.token }}@github.com/".insteadOf "[email protected]:"
+      if: ${{ inputs.token != null }}
+      shell: bash

.github/workflows/ci.yml

@@ -22,33 +22,38 @@ jobs:
     if: needs.skip-duplicates.outputs.should_skip != 'true'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: ./.github/workflows/actions/checkout
         with:
-          submodules: recursive
+          token: ${{ secrets.CI_READ }}
       - uses: ./.github/workflows/actions/rust-toolchain
+        with:
+          personal-access-token: ${{ secrets.CI_READ }}
       - run: cargo check --all-features
 
   test:
     needs: skip-duplicates
     if: needs.skip-duplicates.outputs.should_skip != 'true'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: ./.github/workflows/actions/checkout
         with:
-          submodules: recursive
+          token: ${{ secrets.CI_READ }}
       - uses: ./.github/workflows/actions/rust-toolchain
+        with:
+          personal-access-token: ${{ secrets.CI_READ }}
       - run: cargo test --all-features
 
   fmt:
     needs: skip-duplicates
     if: needs.skip-duplicates.outputs.should_skip != 'true'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: ./.github/workflows/actions/checkout
         with:
-          submodules: recursive
+          token: ${{ secrets.CI_READ }}
       - uses: ./.github/workflows/actions/rust-toolchain
         with:
+          personal-access-token: ${{ secrets.CI_READ }}
           toolchain: nightly
       - run: rustup component add rustfmt
       - run: cargo fmt --all --check
@@ -59,9 +64,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: ./.github/workflows/actions/checkout
         with:
-          submodules: recursive
+          token: ${{ secrets.CI_READ }}
       - uses: ./.github/workflows/actions/rust-toolchain
+        with:
+          personal-access-token: ${{ secrets.CI_READ }}
       - run: rustup component add clippy
       - run: cargo clippy --all-features -- --deny warnings
 
@@ -71,7 +79,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: ./.github/workflows/actions/checkout
         with:
-          submodules: recursive
+          token: ${{ secrets.CI_READ }}
       - uses: ./.github/workflows/actions/rust-toolchain
+        with:
+          personal-access-token: ${{ secrets.CI_READ }}
       - run: cargo doc --all-features --no-deps