rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-15 14:27:50 +02:00
Code Issues Releases Activity
This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.
1,511 Commits 28 Branches 0 Tags 49 MiB
Rust 63.3%
JavaScript 13.3%
Handlebars 7%
Assembly 6.7%
TypeScript 4.5%
Other 5.2%
6a30bbe54a
Go to file
dependabot[bot] 6a30bbe54a
build(deps): bump actions/labeler from 4 to 5 (#1619) 
Bumps [actions/labeler](https://github.com/actions/labeler) from 4 to 5.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/actions/labeler/releases">actions/labeler's
releases</a>.</em></p>
<blockquote>
<h2>v5.0.0</h2>
<h2>What's Changed</h2>
<p>This release contains the following breaking changes:</p>
<ol>
<li>
<p>The ability to apply labels based on the names of base and/or head
branches was added (<a
href="https://redirect.github.com/actions/labeler/issues/186">#186</a>
and <a
href="https://redirect.github.com/actions/labeler/issues/54">#54</a>).
The match object for changed files was expanded with new combinations in
order to make it more intuitive and flexible (<a
href="https://redirect.github.com/actions/labeler/issues/423">#423</a>
and <a
href="https://redirect.github.com/actions/labeler/issues/101">#101</a>).
As a result, the configuration file structure was significantly
redesigned and is not compatible with the structure of the previous
version. Please read the <a
href="https://github.com/actions/labeler/tree/main#pull-request-labeler">action
documentation</a> to find out how to adapt your configuration files for
use with the new action version.</p>
</li>
<li>
<p>The bug related to the <code>sync-labels</code> input was fixed (<a
href="https://redirect.github.com/actions/labeler/issues/112">#112</a>).
Now the input value is read correctly.</p>
</li>
<li>
<p>By default, <code>dot</code> input is set to <code>true</code>. Now,
paths starting with a dot (e.g. <code>.github</code>) are matched by
default.</p>
</li>
<li>
<p>Version 5 of this action updated the <a
href="https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions">runtime
to Node.js 20</a>. All scripts are now run with Node.js 20 instead of
Node.js 16 and are affected by any breaking changes between Node.js 16
and 20.</p>
</li>
</ol>
<p>For more information, please read the <a
href="https://github.com/actions/labeler/tree/main#pull-request-labeler">action
documentation</a>.</p>
<h2>New Contributors</h2>
<ul>
<li><a href="https://github.com/joshdales"><code>@​joshdales</code></a>
made their first contribution in <a
href="https://redirect.github.com/actions/labeler/pull/203">actions/labeler#203</a></li>
<li><a
href="https://github.com/dusan-trickovic"><code>@​dusan-trickovic</code></a>
made their first contribution in <a
href="https://redirect.github.com/actions/labeler/pull/626">actions/labeler#626</a></li>
<li><a href="https://github.com/sungh0lim"><code>@​sungh0lim</code></a>
made their first contribution in <a
href="https://redirect.github.com/actions/labeler/pull/630">actions/labeler#630</a></li>
<li><a
href="https://github.com/TrianguloY"><code>@​TrianguloY</code></a> made
their first contribution in <a
href="https://redirect.github.com/actions/labeler/pull/629">actions/labeler#629</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/labeler/compare/v4...v5.0.0">https://github.com/actions/labeler/compare/v4...v5.0.0</a></p>
<h2>v5.0.0-beta.1</h2>
<h2>What's Changed</h2>
<p>In scope of this beta release, the structure of the configuration
file (<code>.github/labeler.yml</code>) was changed from</p>
<pre lang="yml"><code>LabelName:
- any:
  - changed-files: ['list', 'of', 'globs']
  - base-branch: ['list', 'of', 'regexps']
  - head-branch: ['list', 'of', 'regexps']
- all:
  - changed-files: ['list', 'of', 'globs']
  - base-branch: ['list', 'of', 'regexps']
  - head-branch: ['list', 'of', 'regexps']
</code></pre>
<p>to</p>
<pre lang="yml"><code>LabelName:
- any:
  - changed-files: 
    - AnyGlobToAnyFile: ['list', 'of', 'globs']
    - AnyGlobToAllFiles: ['list', 'of', 'globs']
    - AllGlobsToAnyFile: ['list', 'of', 'globs']
    - AllGlobsToAllFiles: ['list', 'of', 'globs']
  - base-branch: ['list', 'of', 'regexps']
  - head-branch: ['list', 'of', 'regexps']
- all:
  - changed-files:
    - AnyGlobToAnyFile: ['list', 'of', 'globs']
    - AnyGlobToAllFiles: ['list', 'of', 'globs']
    - AllGlobsToAnyFile: ['list', 'of', 'globs']
&lt;/tr&gt;&lt;/table&gt; 
</code></pre>
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="8558fd7429"><code>8558fd7</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/labeler/issues/709">#709</a>
from actions/v5.0.0-beta</li>
<li><a
href="000ca75fe6"><code>000ca75</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/labeler/issues/700">#700</a>
from MaksimZhukov/apply-suggestions-and-update-docume...</li>
<li><a
href="cb66c2f078"><code>cb66c2f</code></a>
Update dist</li>
<li><a
href="9181355e36"><code>9181355</code></a>
Apply suggestions for the beta vesrion and update the documentation</li>
<li><a
href="efe4c1c90e"><code>efe4c1c</code></a>
Merge pull request <a
href="https://redirect.github.com/actions/labeler/issues/699">#699</a>
from MaksimZhukov/update-node-runtime-and-dependencies</li>
<li><a
href="c0957ad7c3"><code>c0957ad</code></a>
Run Prettier</li>
<li><a
href="8dc8d1842f"><code>8dc8d18</code></a>
Update Node.js version in reusable workflows</li>
<li><a
href="d0d0bbebfb"><code>d0d0bbe</code></a>
Update documentation</li>
<li><a
href="1375c42512"><code>1375c42</code></a>
5.0.0</li>
<li><a
href="ab7411ec21"><code>ab7411e</code></a>
Change version of Node.js runtime to node20</li>
<li>Additional commits viewable in <a
href="https://github.com/actions/labeler/compare/v4...v5">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/labeler&package-manager=github_actions&previous-version=4&new-version=5)](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>
Co-authored-by: Martin Geisler <martin@geisler.net>
2024-01-01 21:57:24 -05:00
.github build(deps): bump actions/labeler from 4 to 5 (#1619) 2024-01-01 21:57:24 -05:00
mdbook-course build(deps): bump serde_json from 1.0.108 to 1.0.109 (#1632) 2024-01-01 16:54:29 -05:00
mdbook-exerciser Format all Markdown files with dprint (#1157) 2023-12-31 00:15:07 +01:00
po Format all Markdown files with dprint (#1157) 2023-12-31 00:15:07 +01:00
src build(deps): bump thiserror from 1.0.51 to 1.0.53 (#1626) 2024-01-01 16:31:17 +00:00
theme Fix typos (#1608) 2023-12-20 18:21:54 +00:00
third_party More tiny fixes (#1577) 2023-12-11 16:13:54 -05:00
.gitignore Comprehensive Rust v2 (#1073) 2023-11-29 16:39:24 +01:00
aspect-ratio-helper.py Format Python files with YAPF (#1360) 2023-10-18 13:56:05 -04:00
book.toml Fix mdbook redirection table (#1567) 2023-12-07 15:51:42 +00:00
Cargo.lock build(deps): bump serde_json from 1.0.108 to 1.0.109 (#1632) 2024-01-01 16:54:29 -05:00
Cargo.toml Comprehensive Rust v2 (#1073) 2023-11-29 16:39:24 +01:00
CONTRIBUTING.md Update Windows Gettext installation instructions (#1447) 2023-11-06 13:05:13 -08:00
dprint.json Format all Markdown files with dprint (#1157) 2023-12-31 00:15:07 +01:00
LICENSE Rename LICENSE.txt to LICENSE (#293) 2023-01-29 14:20:55 +01:00
README.md Add Chromium section (#1479) 2023-11-27 18:21:19 +00:00
rustfmt.toml Format all Markdown files with dprint (#1157) 2023-12-31 00:15:07 +01:00
STYLE.md Add guidance that variable names shouldn't be translated to STYLE.md (#1480) 2023-11-15 10:25:46 -08:00
TRANSLATIONS.md build(deps): bump actions/labeler from 4 to 5 (#1619) 2024-01-01 21:57:24 -05:00

README.md

Comprehensive Rust 🦀

Build workflow GitHub contributors GitHub stars

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:

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.