mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-03-06 08:49:17 +02:00
3f385a76f9
Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 1 to 3. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/upload-pages-artifact/releases">actions/upload-pages-artifact's releases</a>.</em></p> <blockquote> <h2>v3.0.0</h2> <h1>Changelog</h1> <ul> <li>Use <code>v4</code> upload-artifact tag <a href="https://github.com/robherley"><code>@robherley</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/80">#80</a>)</li> <li>Upload pages artifact with upload-artifact v4-beta <a href="https://github.com/konradpabjan"><code>@konradpabjan</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/78">#78</a>)</li> </ul> <p>To deploy a GitHub Pages site which has been uploaded with this version of <code>actions/upload-pages-artifact</code>, you must also use <code>actions/deploy-pages@v4</code> or newer.</p> <p>See details of <a href="https://github.com/actions/upload-pages-artifact/compare/v2.0.0...v3.0.0">all code changes</a> since previous release.</p> <h2>v2.0.0</h2> <h1>Changelog</h1> <ul> <li>⚠️ <strong>BREAKING CHANGE:</strong> Remove built-in <code>chmod</code> commands for <code>v2</code> <a href="https://github.com/JamesMGreene"><code>@JamesMGreene</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/69">#69</a>)</li> <li>Update README for <code>v2</code> <a href="https://github.com/JamesMGreene"><code>@JamesMGreene</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/70">#70</a>)</li> </ul> <p>See details of <a href="https://github.com/actions/upload-pages-artifact/compare/v1.0.10...v2.0.0">all code changes</a> since previous release.</p> <h2>v1.0.10</h2> <h1>Changelog</h1> <ul> <li>readme: fix/improve note about permissions <a href="https://github.com/tshepang"><code>@tshepang</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/65">#65</a>)</li> <li>Revert <code>chmod</code> removal for <code>v1</code> <a href="https://github.com/JamesMGreene"><code>@JamesMGreene</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/68">#68</a>)</li> <li>Add file perms handling <a href="https://github.com/tsusdere"><code>@tsusdere</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/64">#64</a>)</li> </ul> <p>See details of <a href="https://github.com/actions/upload-pages-artifact/compare/v1.0.9...v1.0.10">all code changes</a> since previous release.</p> <h2>v1.0.9</h2> <p>Removed <code>chmod</code> as we moved towards trusting correct file permissions have been set. In the event this isn't the case then we raise an error in the action related to the file permissions.</p> <h2>v1.0.8</h2> <h1>Changelog</h1> <ul> <li>Fail if no artifact file is found to upload <a href="https://github.com/JamesMGreene"><code>@JamesMGreene</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/55">#55</a>)</li> <li>Fix link to releases in README <a href="https://github.com/waldyrious"><code>@waldyrious</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/53">#53</a>)</li> <li>Bump actions/publish-action from 0.2.1 to 0.2.2 <a href="https://github.com/dependabot"><code>@dependabot</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/47">#47</a>)</li> <li>Add Dependabot config for Actions usage updates <a href="https://github.com/JamesMGreene"><code>@JamesMGreene</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/46">#46</a>)</li> </ul> <p>See details of <a href="https://github.com/actions/upload-pages-artifact/compare/v1.0.7...v1.0.8">all code changes</a> since previous release.</p> <h2>v1.0.7</h2> <h1>Changelog</h1> <ul> <li>Don't change file permissions of other files <a href="https://github.com/KyeRussell"><code>@KyeRussell</code></a> (<a href="https://redirect.github.com/actions/upload-pages-artifact/issues/44">#44</a>)</li> </ul> <p>See details of <a href="https://github.com/actions/upload-pages-artifact/compare/v1.0.6...v1.0.7">all code changes</a> since previous release.</p> <h2>v1.0.6</h2> <h1>Changelog</h1> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="0252fc4ba7"><code>0252fc4</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/81">#81</a> from actions/artifacts-next</li> <li><a href="2a5c144074"><code>2a5c144</code></a> Use actions/download-artifact@v4 in test</li> <li><a href="7e3f6bb53b"><code>7e3f6bb</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/80">#80</a> from robherley/patch-1</li> <li><a href="257e666c05"><code>257e666</code></a> Use <code>v4</code> upload-artifact tag</li> <li><a href="0313a19afa"><code>0313a19</code></a> Merge pull request <a href="https://redirect.github.com/actions/upload-pages-artifact/issues/78">#78</a> from konradpabjan/main</li> <li><a href="1228e65686"><code>1228e65</code></a> Update action.yml</li> <li><a href="eb31309b6c"><code>eb31309</code></a> Update artifact names in tests</li> <li><a href="241a975ec2"><code>241a975</code></a> Correct artifact name during download</li> <li><a href="ef95519d72"><code>ef95519</code></a> Unique artifact name per job</li> <li><a href="ecdd3edff7"><code>ecdd3ed</code></a> Switch to using download@v4-beta</li> <li>Additional commits viewable in <a href="https://github.com/actions/upload-pages-artifact/compare/v1...v3">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Comprehensive Rust 🦀
This repository has the source code for Comprehensive Rust 🦀, a multi-day Rust course developed by the Android team. The course covers all aspects of Rust, from basic syntax to generics and error handling. It also includes deep dives on Android, Chromium, bare-metal, and concurrency.
Read the course at https://google.github.io/comprehensive-rust/.
Course Format and Target Audience
The course is used internally at Google when teaching Rust to experienced software engineers. They typically have a background in C++ or Java.
The course is taught in a classroom setting and we hope it will be useful for others who want to teach Rust to their team. The course will be less useful for self-study since you miss out on the discussions happening in the classroom. You don't see the questions and answers and you don't see the compiler errors we trigger when going through the code samples. We hope to improve on this via speaker notes and by publishing videos.
Press
Articles and blog posts from around the web which cover Comprehensive Rust:
- 2023-09-08: Teaching Rust in 5 days. Comprehensive Rust was used as a base for a 5-day university class on Rust.
- 2023-09-21: Scaling Rust Adoption Through Training. We published a blog post with details on the development of the course.
- 2023-10-02: In Search of Rust Developers, Companies Turn to In-House Training. About how Microsoft, Google, and others are training people in Rust.
Building
The course is built using a few tools:
First install Rust by following the instructions on https://rustup.rs/. Then clone this repository:
git clone https://github.com/google/comprehensive-rust/
cd comprehensive-rust
Then install these tools with:
cargo install mdbook
cargo install mdbook-svgbob
cargo install mdbook-i18n-helpers
cargo install --path mdbook-exerciser
cargo install --path mdbook-course
Run
mdbook test
to test all included Rust snippets. Run
mdbook serve
to start a web server with the course. You'll find the content on
http://localhost:3000. You can use mdbook build to create a static version
of the course in the book/ directory. Note that you have to separately build
and zip exercises and add them to book/html. To build any of the translated
versions of the course, run MDBOOK_BOOK__LANGUAGE=xx mdbook build -d book/xx
where xx is the ISO 639 language code (e.g. da for the Danish translation).
TRANSLATIONS.md contains further instructions.
Note
On Windows, you need to enable symlinks (
git config --global core.symlinks true) and Developer Mode.
Contact
For questions or comments, please contact Martin Geisler or start a discussion on GitHub. We would love to hear from you.