Skip to content

add github action docs file#1454

Closed
aviramha wants to merge 1 commit intomozilla:mainfrom
aviramha:gha_readme
Closed

add github action docs file#1454
aviramha wants to merge 1 commit intomozilla:mainfrom
aviramha:gha_readme

Conversation

@aviramha
Copy link

@aviramha aviramha commented Dec 7, 2022

No description provided.

@sylvestre
Copy link
Collaborator

@jakelee8 what do you think about this ?

@codecov-commenter
Copy link

Codecov Report

Base: 23.72% // Head: 23.16% // Decreases project coverage by -0.55% ⚠️

Coverage data is based on head (def9f0f) compared to base (b7caab4).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1454      +/-   ##
==========================================
- Coverage   23.72%   23.16%   -0.56%     
==========================================
  Files          48       49       +1     
  Lines       22336    22409      +73     
  Branches    10222    10260      +38     
==========================================
- Hits         5300     5192     -108     
- Misses      11402    11576     +174     
- Partials     5634     5641       +7     
Impacted Files Coverage Δ
src/jobserver.rs 47.91% <0.00%> (-4.17%) ⬇️
src/cache/disk.rs 35.61% <0.00%> (-2.74%) ⬇️
src/util.rs 33.75% <0.00%> (-2.50%) ⬇️
src/azure/blobstore.rs 21.05% <0.00%> (-2.11%) ⬇️
src/cache/cache.rs 36.82% <0.00%> (-1.98%) ⬇️
src/compiler/args.rs 60.31% <0.00%> (-1.77%) ⬇️
src/compiler/gcc.rs 54.49% <0.00%> (-1.52%) ⬇️
src/mock_command.rs 50.93% <0.00%> (-1.50%) ⬇️
src/lib.rs 9.69% <0.00%> (-0.99%) ⬇️
src/compiler/c.rs 38.24% <0.00%> (-0.98%) ⬇️
... and 20 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@jakelee8
Copy link
Contributor

jakelee8 commented Dec 7, 2022

I would consider sccache a "trusted" component in the software supply chain and recommend against using 3rd-party GitHub Actions in official sccache documentation. That said, @metalbear-co/sccache-action is still a work in progress.

For a more complete example of using GHA sccache with Cargo, including cross-platform support, see https://github.com/BitskiCo/rust-sdk/blob/main/bin/cargo


```yaml
- name: Cache Rust compilation
uses: metalbear-co/sscache-action@v1.0.2
Copy link
Collaborator

Choose a reason for hiding this comment

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

Sorry but I am not confortable recommending this
Could you please remove this?

Copy link
Collaborator

Choose a reason for hiding this comment

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

or if you are interested, we could discuss about moving the action under the Mozilla umbrella

Copy link
Collaborator

Choose a reason for hiding this comment

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

I was about suggest that, and invest a few hours into vetting and polishing so we can endorse something that's easier to use compared to a DIY manual.

The action will automatically download and install `sccache` and configure it to use the GitHub Actions cache.
It will add `RUSTC_WRAPPER` environment to your build steps to use `sccache` as the compiler wrapper.

Just add this step to your workflow:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe something like:

Suggested change
Just add this step to your workflow:
To integrate this into your workflow, you can see how it is done in this script:
https://github.com/BitskiCo/rust-sdk/blob/main/bin/cargo

@aviramha
Copy link
Author

aviramha commented Dec 7, 2022

Answering all replies in one spot:

  • I understand the concern for recommending a 3rd party in the official docs, though I think that many other official projects do so, sometimes with a disclaimer - it is ofc entirely up to the maintainer team so I can't really say anything besides that.
  • Moving the action to the Mozilla umbrella - the current repo can be forked as it's MIT though I'm not sure I want to be bound by the Mozilla umbrella (not sure what are the implications)
  • I am ofc biased, and don't want to push my biased opinion into the project. I'll close the PR and let you decide how you want to document it and share it.

@aviramha aviramha closed this Dec 7, 2022
tottoto pushed a commit to tottoto/sccache that referenced this pull request Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants