Sync upstream

.github/dependabot.yaml

@@ -0,0 +1,50 @@
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates#setting-up-a-cooldown-period-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: cargo
+    directories:
+      - tests
+      - tests/wasm-workspace
+    schedule:
+      interval: weekly
+    # https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#groups--
+    # 1 PR per week and group
+    groups:
+      cargo-major:
+        update-types: ["major"]
+      cargo-minor:
+        update-types: ["minor"]
+      cargo-patch:
+        update-types: ["patch"]
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      actions:
+        # Combine all images of the last week
+        patterns: ["*"]
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      prd-major:
+        dependency-type: "production"
+        update-types: ["major"]
+      prd-minor:
+        dependency-type: "production"
+        update-types: ["minor"]
+      prd-patch:
+        dependency-type: "production"
+        update-types: ["patch"]
+      dev-major:
+        dependency-type: "development"
+        update-types: ["major"]
+      dev-minor:
+        dependency-type: "development"
+        update-types: ["minor"]
+      dev-patch:
+        dependency-type: "development"
+        update-types: ["patch"]

.github/workflows/check-dist.yml

@@ -13,9 +13,10 @@ on:
 
 jobs:
   check-dist:
+    if: github.repository == 'WarpBuilds/rust-cache'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup Node.js 20.x
         uses: actions/setup-node@v4
@@ -38,7 +39,7 @@ jobs:
           fi
         id: diff
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/coverage.yml

@@ -4,6 +4,7 @@ on: [push, pull_request]
 
 jobs:
   coverage:
+    if: github.repository == 'WarpBuilds/rust-cache'
     strategy:
       fail-fast: false
       matrix:
@@ -16,7 +17,7 @@ jobs:
       CARGO_TERM_COLOR: always
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - run: rustup toolchain install stable --profile minimal --component llvm-tools-preview --no-self-update
 

.github/workflows/dependabot.yml

@@ -0,0 +1,63 @@
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#enabling-automerge-on-a-pull-request
+
+name: Dependabot Automation
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'WarpBuilds/rust-cache'
+    steps:
+      - name: Fetch metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 2
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+      - name: Check if package-lock.json has been changed
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        id: npm
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          if ! git diff --quiet HEAD~1.. -- package-lock.json; then
+            echo "changed=true" >> $GITHUB_OUTPUT
+            echo "changed=true, checking out $PR_URL to allow amend"
+            gh pr checkout "$PR_URL"
+          fi
+      - name: Setup node if necessary
+        if: steps.npm.outputs.changed != ''
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: npm
+      - name: Re-generate and commit dist/ if changed
+        id: amend
+        if: steps.npm.outputs.changed != ''
+        run: |
+          npm ci
+          npm run prepare
+          if ! git diff --quiet dist/*/index.js; then
+            echo "dist/ changed, amending last commit"
+            export $(git log -1 --pretty=format:'GIT_COMMITTER_NAME=%cn GIT_COMMITTER_EMAIL=%ce GIT_AUTHOR_NAME=%an GIT_AUTHOR_EMAIL=%ae')
+            git fetch --unshallow
+            echo "Before amend:" && git show --name-only --pretty=
+            git commit --amend --no-edit --no-reset-author -- dist/*/index.js
+            echo "After amend:" && git show --name-only --pretty=
+            git push --force-with-lease origin HEAD
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+      - name: Auto-merge Patch PRs
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/git-registry.yml

@@ -4,6 +4,7 @@ on: [push, pull_request]
 
 jobs:
   git-registry:
+    if: github.repository == 'WarpBuilds/rust-cache'
     strategy:
       fail-fast: false
       matrix:
@@ -17,7 +18,7 @@ jobs:
       CARGO_REGISTRIES_CRATES_IO_PROTOCOL: git
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - run: rustup toolchain install stable --profile minimal --no-self-update
 

.github/workflows/install.yml

@@ -4,6 +4,7 @@ on: [push, pull_request]
 
 jobs:
   install:
+    if: github.repository == 'WarpBuilds/rust-cache'
     strategy:
       fail-fast: false
       matrix:
@@ -16,7 +17,7 @@ jobs:
       CARGO_TERM_COLOR: always
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - run: rustup toolchain install stable --profile minimal --no-self-update
 

.github/workflows/simple.yml

@@ -4,6 +4,7 @@ on: [push, pull_request]
 
 jobs:
   simple:
+    if: github.repository == 'WarpBuilds/rust-cache'
     strategy:
       fail-fast: false
       matrix:
@@ -16,7 +17,7 @@ jobs:
       CARGO_TERM_COLOR: always
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - run: rustup toolchain install stable --profile minimal --no-self-update
 

.github/workflows/target-dir.yml

@@ -4,6 +4,7 @@ on: [push, pull_request]
 
 jobs:
   target-dir:
+    if: github.repository == 'WarpBuilds/rust-cache'
     strategy:
       fail-fast: false
       matrix:
@@ -16,7 +17,7 @@ jobs:
       CARGO_TERM_COLOR: always
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - run: rustup toolchain install stable --profile minimal --no-self-update
 

.github/workflows/workspaces.yml

@@ -4,6 +4,7 @@ on: [push, pull_request]
 
 jobs:
   workspaces:
+    if: github.repository == 'WarpBuilds/rust-cache'
     strategy:
       fail-fast: false
       matrix:
@@ -16,7 +17,7 @@ jobs:
       CARGO_TERM_COLOR: always
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - run: rustup toolchain install stable --profile minimal --target wasm32-unknown-unknown --no-self-update
 
@@ -26,8 +27,10 @@ jobs:
             tests
             tests/wasm-workspace
 
-      - run: cargo check
+      - name: cargo check (tests)
         working-directory: tests
+        run: cargo check
 
-      - run: cargo check
+      - name: cargo check (tests/wasm-workspace)
         working-directory: tests/wasm-workspace
+        run: cargo check

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 2.8.0
+
+- Add support for `warpbuild` cache provider
+- Add new `cache-workspace-crates` feature
+
+## 2.7.8
+
+- Include CPU arch in the cache key
+
+## 2.7.7
+
+- Also cache `cargo install` metadata
+
+## 2.7.6
+
+- Allow opting out of caching $CARGO_HOME/bin
+- Add runner OS in cache key
+- Adds an option to do lookup-only of the cache
+
+## 2.7.5
+
+- Support Cargo.lock format cargo-lock v4
+- Only run macOsWorkaround() on macOS
+
 ## 2.7.3
 
 - Work around upstream problem that causes cache saving to hang for minutes.

README.md

@@ -6,13 +6,13 @@ sensible defaults.
 ## Example usage
 
 ```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
 
 # selecting a toolchain either by action or manual `rustup` calls should happen
 # before the plugin, as the cache uses the current rustc version as its cache key
 - run: rustup toolchain install stable --profile minimal
 
-- uses: Swatinem/rust-cache@v2
+- uses: WarpBuilds/rust-cache@v2
   with:
     # The prefix cache key, this can be changed to start a new cache manually.
     # default: "v0-rust"
@@ -60,7 +60,13 @@ sensible defaults.
     # default: "false"
     cache-all-crates: ""
 
-    # Determiners whether the cache should be saved.
+    # Similar to cache-all-crates.
+    # If `true` the workspace crates will be cached.
+    # Useful if the workspace contains libraries that are only updated sporadically.
+    # default: "false"
+    cache-workspace-crates: ""
+
+    # Determines whether the cache should be saved.
     # If `false`, the cache is only restored.
     # Useful for jobs where the matrix is additive e.g. additional Cargo features,
     # or when only runs from `master` should be saved to the cache.
@@ -69,6 +75,20 @@ sensible defaults.
     # To only cache runs from `master`:
     save-if: ${{ github.ref == 'refs/heads/master' }}
 
+    # Determines whether the cache should be restored.
+    # If `true` the cache key will be checked and the `cache-hit` output will be set
+    # but the cache itself won't be restored
+    # default: "false"
+    lookup-only: ""
+
+    # Specifies what to use as the backend providing cache
+    # Can be set to "github", "buildjet", or "warpbuild"
+    # default: "github"
+    cache-provider: ""
+
+    # Determines whether to cache the ~/.cargo/bin directory.
+    # default: "true"
+    cache-bin: ""
 ```
 
 Further examples are available in the [.github/workflows](./.github/workflows/) directory.
@@ -119,7 +139,7 @@ Before being persisted, the cache is cleaned of:
 - Any build artifacts with an `mtime` older than one week.
 
 In particular, the workspace crates themselves are not cached since doing so is
-[generally not effective](https://github.com/Swatinem/rust-cache/issues/37#issuecomment-944697938).
+[generally not effective](https://github.com/WarpBuilds/rust-cache/issues/37#issuecomment-944697938).
 For this reason, this action automatically sets `CARGO_INCREMENTAL=0` to disable
 incremental compilation, so that the Rust compiler doesn't waste time creating
 the additional artifacts required for incremental builds.
@@ -165,4 +185,7 @@ to see those details as well as further details related to caching operations.
 ## Known issues
 
 - The cache cleaning process currently removes all the files from `~/.cargo/bin`
-  that were present before the action ran (for example `rustc`).
+  that were present before the action ran (for example `rustc`), by default.
+  This can be an issue on long-running self-hosted runners, where such state
+  is expected to be preserved across runs.  You can work around this by setting
+  `cache-bin: "false"`.

action.yml

@@ -32,11 +32,26 @@ inputs:
     description: "Determines which crates are cached. If `true` all crates will be cached, otherwise only dependent crates will be cached."
     required: false
     default: "false"
+  cache-workspace-crates:
+    description: "Similar to cache-all-crates. If `true` the workspace crates will be cached."
+    required: false
+    default: "false"
   save-if:
     description: "Determiners whether the cache should be saved. If `false`, the cache is only restored."
     required: false
     default: "true"
-
+  cache-provider:
+    description: "Determines which provider to use for caching. Options are github, buildjet, or warpbuild. Defaults to github."
+    required: false
+    default: "github"
+  cache-bin:
+    description: "Determines whether to cache ${CARGO_HOME}/bin."
+    required: false
+    default: "true"
+  lookup-only:
+    description: "Check if a cache entry exists without downloading the cache"
+    required: false
+    default: "false"
 outputs:
   cache-hit:
     description: "A boolean value that indicates an exact match was found."