rust-lang / rust-lang/rustup

Exract manifest handling into its own crate

Open
#1,112 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
22h 40m
Merged PRs (30d)
46

Description

The build-manifest tool inside rust-lang/rust is responsible for creating manifests, and the manifest module in rustup-dist is responsible for reading and validating manifests. There have already been bugs where manifests produced by the Rust build system failed to validate. It would be preferable if the code was in a single crate and shared between the two projects.

Extract manifest.rs into its own crate, then plug that crate back into rustup, and into build-manifest. Modify build-manifest to run the validate method before writing the manifest. Extract manifest-specific tests as well. Look for other code to share between them.

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

Start with the manifest module in rustup-dist and the build-manifest tool in rust-lang/rust, then inspect the manifest-specific tests and the existing validate method. Extract the shared manifest handling into a crate, integrate it with both consumers, and verify that build-manifest validates manifests before writing them.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, release
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.