Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add BuildJet Option #154

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Add BuildJet Option #154

merged 2 commits into from
Aug 1, 2023

Conversation

joroshiba
Copy link
Contributor

When using self hosted runners, or BuildJet, using the default GH cache can be slow (I've seen as slow as 5mb/s). Using BuildJet cache has been reliably faster for me in these scenarios (consistently 100mb/s). This PR adds an option which allow users to switch back and forth.

The changes for the drop in are based in part on BuildJet's own action

This was referenced Jul 27, 2023
Open
Merged
Swatinem
Swatinem reviewed Jul 30, 2023
View reviewed changes
Copy link
Owner

@Swatinem Swatinem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is surprisingly straight forward, thanks for the work!

Just some minor nits, otherwise this is good to go.

README.md Outdated Show resolved Hide resolved
src/restore.ts Outdated Show resolved Hide resolved
@Swatinem
Copy link
Owner

Another question is about testing: Is buildjet available transparently for open source and github-hosted runners? (aka this repo)
If so, it might be worth adding a new test example that is using this cache backend.

@MOZGIII
Copy link

MOZGIII commented Jul 30, 2023 •
edited
Loading

Wow, this is cool! I think S3 cache can be added in a similar manner: there is a number of forks of the actions/cache with the only change being the S3 backend instead of the GH backend.
Given the possibility it would be this easy, maybe this PR should use something like cacheBackend: "github" | "buildjet"? It is a bit more forward-compatible than adding a boolean...

@joroshiba
Copy link
Contributor Author

Updated to allow for more extensibility, added a test.

@joroshiba joroshiba force-pushed the add-buildjet-option branch from 4183cd5 to 1591ab5 Compare July 31, 2023 21:32
@Swatinem Swatinem merged commit b00faf5 into Swatinem:master Aug 1, 2023
renovate bot referenced this pull request in 4m-mazi/gh-test Aug 10, 2023
@renovate
ci(deps): update swatinem/rust-cache action to v2.6.0 (#370)
2b81479 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [Swatinem/rust-cache](https://github.com/Swatinem/rust-cache) |
action | minor | `v2.5.1` -> `v2.6.0` |

---

### Release Notes

<details>
<summary>Swatinem/rust-cache (Swatinem/rust-cache)</summary>

###
[`v2.6.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.5.1...v2.6.0)

##### What's Changed

- Add "buildjet" as a second `cache-provider` backend
[@&#8203;joroshiba](https://github.com/joroshiba) in
[https://github.com/Swatinem/rust-cache/pull/154](https://github.com/Swatinem/rust-cache/pull/154)
-   Clean up sparse registry index.
-   Do not clean up src of `-sys` crates.
-   Remove `.cargo/credentials.toml` before saving.

##### New Contributors

- [@&#8203;joroshiba](https://github.com/joroshiba) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/154](https://github.com/Swatinem/rust-cache/pull/154)

**Full Changelog**:
Swatinem/rust-cache@v2.5.1...v2.6.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Mogyuchi/gh-test).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40MC4zIiwidXBkYXRlZEluVmVyIjoiMzYuNDAuMyIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@neysofu neysofu mentioned this pull request Aug 28, 2023
Merged
github-merge-queue bot referenced this pull request in knope-dev/knope Jan 12, 2024
@renovate
chore(deps): update dependency swatinem/rust-cache to v2.7.2 (#778)
e70bd1e 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [Swatinem/rust-cache](https://github.com/Swatinem/rust-cache) |
minor | `v2` -> `v2.7.2` |

---

### Release Notes

<details>
<summary>Swatinem/rust-cache (Swatinem/rust-cache)</summary>

###
[`v2.7.2`](https://github.com/Swatinem/rust-cache/releases/tag/v2.7.2)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.7.0...v2.7.2)

#### What's Changed

- Update action runtime to `node20` by
[@&#8203;rhysd](https://github.com/rhysd) in
[https://github.com/Swatinem/rust-cache/pull/175](https://github.com/Swatinem/rust-cache/pull/175)
- Only key by `Cargo.toml` and `Cargo.lock` files of workspace members
by [@&#8203;max-heller](https://github.com/max-heller) in
[https://github.com/Swatinem/rust-cache/pull/180](https://github.com/Swatinem/rust-cache/pull/180)

#### New Contributors

- [@&#8203;rhysd](https://github.com/rhysd) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/175](https://github.com/Swatinem/rust-cache/pull/175)
- [@&#8203;max-heller](https://github.com/max-heller) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/180](https://github.com/Swatinem/rust-cache/pull/180)

**Full Changelog**:
Swatinem/rust-cache@v2.7.1...v2.7.2

###
[`v2.7.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.7.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.6.2...v2.7.0)

##### What's Changed

- Fix save-if documentation in readme by
[@&#8203;rukai](https://github.com/rukai) in
[https://github.com/Swatinem/rust-cache/pull/166](https://github.com/Swatinem/rust-cache/pull/166)
- Support for `trybuild` and similar macro testing tools by
[@&#8203;neysofu](https://github.com/neysofu) in
[https://github.com/Swatinem/rust-cache/pull/168](https://github.com/Swatinem/rust-cache/pull/168)

##### New Contributors

- [@&#8203;rukai](https://github.com/rukai) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/166](https://github.com/Swatinem/rust-cache/pull/166)
- [@&#8203;neysofu](https://github.com/neysofu) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/168](https://github.com/Swatinem/rust-cache/pull/168)

**Full Changelog**:
Swatinem/rust-cache@v2.6.2...v2.7.0

###
[`v2.6.2`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.2)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.6.1...v2.6.2)

##### What's Changed

- dep: Use `smol-toml` instead of `toml` by
[@&#8203;NobodyXu](https://github.com/NobodyXu) in
[https://github.com/Swatinem/rust-cache/pull/164](https://github.com/Swatinem/rust-cache/pull/164)

**Full Changelog**:
Swatinem/rust-cache@v2...v2.6.2

###
[`v2.6.1`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.1)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.6.0...v2.6.1)

-   Fix hash contributions of `Cargo.lock`/`Cargo.toml` files.

###
[`v2.6.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.5.1...v2.6.0)

##### What's Changed

- Add "buildjet" as a second `cache-provider` backend
[@&#8203;joroshiba](https://github.com/joroshiba) in
[https://github.com/Swatinem/rust-cache/pull/154](https://github.com/Swatinem/rust-cache/pull/154)
-   Clean up sparse registry index.
-   Do not clean up src of `-sys` crates.
-   Remove `.cargo/credentials.toml` before saving.

##### New Contributors

- [@&#8203;joroshiba](https://github.com/joroshiba) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/154](https://github.com/Swatinem/rust-cache/pull/154)

**Full Changelog**:
Swatinem/rust-cache@v2.5.1...v2.6.0

###
[`v2.5.1`](https://github.com/Swatinem/rust-cache/releases/tag/v2.5.1)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.5.0...v2.5.1)

-   Fix hash contribution of `Cargo.lock`.

###
[`v2.5.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.5.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.4.0...v2.5.0)

##### What's Changed

- feat: Rm workspace crates version before caching by
[@&#8203;NobodyXu](https://github.com/NobodyXu) in
[https://github.com/Swatinem/rust-cache/pull/147](https://github.com/Swatinem/rust-cache/pull/147)
- feat: Add hash of `.cargo/config.toml` to key by
[@&#8203;NobodyXu](https://github.com/NobodyXu) in
[https://github.com/Swatinem/rust-cache/pull/149](https://github.com/Swatinem/rust-cache/pull/149)

##### New Contributors

- [@&#8203;NobodyXu](https://github.com/NobodyXu) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/147](https://github.com/Swatinem/rust-cache/pull/147)

**Full Changelog**:
Swatinem/rust-cache@v2.4.0...v2.5.0

###
[`v2.4.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.4.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.3.0...v2.4.0)

-   Fix cache key stability.
- Use 8 character hash components to reduce the key length, making it
more readable.

###
[`v2.3.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.3.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.2.1...v2.3.0)

- Add `cache-all-crates` option, which enables caching of crates
installed by workflows.
- Add installed packages to cache key, so changes to workflows that
install rust tools are detected and cached properly.
-   Fix cache restore failures due to upstream bug.
-   Fix `EISDIR` error due to globed directories.
- Update runtime `@actions/cache`, `@actions/io` and dev `typescript`
dependencies.
- Update `npm run prepare` so it creates distribution files with the
right line endings.

###
[`v2.2.1`](https://github.com/Swatinem/rust-cache/releases/tag/v2.2.1)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.2.0...v2.2.1)

- Update `@actions/cache` dependency to fix usage of `zstd` compression.

###
[`v2.2.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.2.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.1.0...v2.2.0)

- Add new `save-if` option to always restore, but only conditionally
save the cache.

###
[`v2.1.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.1.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.0.2...v2.1.0)

- Only hash `Cargo.{lock,toml}` files in the configured workspace
directories.

###
[`v2.0.2`](https://github.com/Swatinem/rust-cache/releases/tag/v2.0.2)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.0.1...v2.0.2)

-   Avoid calling cargo metadata on pre-cleanup.
-   Added `prefix-key`, `cache-directories` and `cache-targets` options.

###
[`v2.0.1`](https://github.com/Swatinem/rust-cache/releases/tag/v2.0.1)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2...v2.0.1)

- Primarily just updating dependencies to fix GitHub deprecation
notices.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/knope-dev/knope).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEyNy4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
zharinov referenced this pull request in zharinov/verver Feb 28, 2024
@renovate
chore(deps): update swatinem/rust-cache action to v2.7.3 (#39)
d529c8d 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [Swatinem/rust-cache](https://github.com/Swatinem/rust-cache) |
action | minor | `v2.5.1` -> `v2.7.3` |

---

### Release Notes

<details>
<summary>Swatinem/rust-cache (Swatinem/rust-cache)</summary>

###
[`v2.7.3`](https://github.com/Swatinem/rust-cache/releases/tag/v2.7.3)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.7.2...v2.7.3)

- Work around upstream problem that causes cache saving to hang for
minutes.

**Full Changelog**:
Swatinem/rust-cache@v2.7.2...v2.7.3

###
[`v2.7.2`](https://github.com/Swatinem/rust-cache/releases/tag/v2.7.2)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.7.1...v2.7.2)

##### What's Changed

- Update action runtime to `node20` by
[@&#8203;rhysd](https://github.com/rhysd) in
[https://github.com/Swatinem/rust-cache/pull/175](https://github.com/Swatinem/rust-cache/pull/175)
- Only key by `Cargo.toml` and `Cargo.lock` files of workspace members
by [@&#8203;max-heller](https://github.com/max-heller) in
[https://github.com/Swatinem/rust-cache/pull/180](https://github.com/Swatinem/rust-cache/pull/180)

##### New Contributors

- [@&#8203;rhysd](https://github.com/rhysd) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/175](https://github.com/Swatinem/rust-cache/pull/175)
- [@&#8203;max-heller](https://github.com/max-heller) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/180](https://github.com/Swatinem/rust-cache/pull/180)

**Full Changelog**:
Swatinem/rust-cache@v2.7.1...v2.7.2

###
[`v2.7.1`](https://github.com/Swatinem/rust-cache/compare/v2.7.0...v2.7.1)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.7.0...v2.7.1)

###
[`v2.7.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.7.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.6.2...v2.7.0)

##### What's Changed

- Fix save-if documentation in readme by
[@&#8203;rukai](https://github.com/rukai) in
[https://github.com/Swatinem/rust-cache/pull/166](https://github.com/Swatinem/rust-cache/pull/166)
- Support for `trybuild` and similar macro testing tools by
[@&#8203;neysofu](https://github.com/neysofu) in
[https://github.com/Swatinem/rust-cache/pull/168](https://github.com/Swatinem/rust-cache/pull/168)

##### New Contributors

- [@&#8203;rukai](https://github.com/rukai) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/166](https://github.com/Swatinem/rust-cache/pull/166)
- [@&#8203;neysofu](https://github.com/neysofu) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/168](https://github.com/Swatinem/rust-cache/pull/168)

**Full Changelog**:
Swatinem/rust-cache@v2.6.2...v2.7.0

###
[`v2.6.2`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.2)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.6.1...v2.6.2)

##### What's Changed

- dep: Use `smol-toml` instead of `toml` by
[@&#8203;NobodyXu](https://github.com/NobodyXu) in
[https://github.com/Swatinem/rust-cache/pull/164](https://github.com/Swatinem/rust-cache/pull/164)

**Full Changelog**:
Swatinem/rust-cache@v2...v2.6.2

###
[`v2.6.1`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.1)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.6.0...v2.6.1)

-   Fix hash contributions of `Cargo.lock`/`Cargo.toml` files.

###
[`v2.6.0`](https://github.com/Swatinem/rust-cache/releases/tag/v2.6.0)

[Compare
Source](https://github.com/Swatinem/rust-cache/compare/v2.5.1...v2.6.0)

##### What's Changed

- Add "buildjet" as a second `cache-provider` backend
[@&#8203;joroshiba](https://github.com/joroshiba) in
[https://github.com/Swatinem/rust-cache/pull/154](https://github.com/Swatinem/rust-cache/pull/154)
-   Clean up sparse registry index.
-   Do not clean up src of `-sys` crates.
-   Remove `.cargo/credentials.toml` before saving.

##### New Contributors

- [@&#8203;joroshiba](https://github.com/joroshiba) made their first
contribution in
[https://github.com/Swatinem/rust-cache/pull/154](https://github.com/Swatinem/rust-cache/pull/154)

**Full Changelog**:
Swatinem/rust-cache@v2.5.1...v2.6.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/zharinov/verver).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4yNy4xIiwidXBkYXRlZEluVmVyIjoiMzcuMTI3LjAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Swatinem Swatinem Swatinem approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@joroshiba @Swatinem @MOZGIII