rust-lang / rust-lang/rust

Tracking issue for release notes of #148051: Stabilize Frontmatter

Open
#151,840 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

F-frontmatter release-blog-post relnotes relnotes-tracking-issue T-lang T-style
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

This issue tracks the release notes text for #148051.

cc @epage, @davidtwco -- original issue/PR authors and assignees for drafting text

See the forge.rust-lang.org chapter about release notes for an overview of how the release team makes use of these tracking issues.

Release notes text

This section should be edited to specify the correct category(s) for the change, with succinct description(s) of what changed. Some things worth considering:

  • Does this need an additional compat notes section?
  • Was this a libs stabilization that should have additional headers to list new APIs under Stabilized APIs and Const Stabilized APIs?
# Language
- [Stabilize Frontmatter](https://github.com/rust-lang/rust/pull/148051)

[!TIP]
Use the previous releases for inspiration on how to write the release notes text and which categories to pick.

Release blog section

If this change is notable enough for inclusion in the blog post then this section should be edited to contain a draft for the blog post. Otherwise leave it empty.

## Cargo script support

Cargo scripts are Rust files with their `Cargo.toml` embedded inside of them using a new Rust syntax called "frontmatter".
This is helpful for
- Self-contained reproduction cases for bug reports
- Communicating using code snippets that use dependencies in blog posts, chat, books, etc
- Exploratory programming

Example:
~~~rust
#!/usr/bin/env cargo
---
[dependencies]
rand = "0.9"
---

use rand::Rng;

fn main() {
    let mut rng = rand::rng();
    let random_number: u32 = rng.random();
    println!("Random number: {random_number}");
}
~~~

[!NOTE]

If a blog post section is required the release-blog-post label should be added (@rustbot label +release-blog-post) to this issue as otherwise it may be missed by the release team.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the forge.rust-lang.org release-notes chapter and previous releases for category conventions. Review the release notes and blog sections in this issue, then confirm the text accurately describes #148051 and add any needed compatibility or API headings; leave the blog section empty if it is not notable enough.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.