paketo-community / rust-dist Goto Github PK

The updater isn't working. It has missed some patch releases and it actually tried to revert a version here. Need to investigate.

https://github.com/paketo-buildpacks/pipeline-builder/blob/main/actions/rust-dependency/main.go

We should change out default branch to be "main". This will align us with the rest of the Paketo project.

Add metadata to document the buildpack configuration settings like BP_RUST_VERSION.

Example: https://github.com/paketo-buildpacks/apache-tomcat/blob/main/buildpack.toml#L29-L32

Implement Dependency Management RFC Phase 1 for rust. Check out the RFC for more details and background.

1. Determine dependency source strategy

• Determine whether the dependency can be used directly from its upstream, rather than undergoing additional compilation/modification.

• If using directly from upstream, note where dependencies will come from
• If compiled or modified, note the decision for this

• Document decision in a language-family level RFC. This decision can be combined in the RFC with the decision made for other buildpacks in the language family.

2. Version retrieval and metadata generation code

Please refer to the retrieval RFC section on version retrieval for details around the API and background.

• Create retrieval code for the dependency

• Will live in the buildpack under: dependency/retrieval/
• Per the RFC, this will be a combination of (1) discovering new dependency versions based on the buildpack.toml, and (2) generating metadata for each new version.
• Note : Per the RFC caveat - if the dependency is to be compiled, the SHA256 and URI field from the metadata should be omitted in this step.

3. Compilation code (if needed)

If the dependency will be compiled/modified, then refer to the compilation RFC section for API details and background.

• Create compilation action

• Will live in the buildpack under: dependency/actions/compile/

4. Dependency testing (optional)

It's up to maintainer discretion if the dependency will be tested. It's recommended to test the dependency if it's been compiled. Check out the testing RFC section for details.

• Add tests for dependency

• Will live in the buildpack under: dependency/test.

5. Makefile Setup

When using the generalized workflows for dependency management down the line, version retrieval and dependency testing will be executed via a Makefile in order to provide the workflow a standardized way to run the code, regardless of what language it was written in. Check out the RFC section for what this should look like.

• Add Makefile

• Will live in the buildpack at: dependency/Makefile

6. Leveraging the new code

This issue serves to set up all the main logic for the dependency management. The work to actually leverage this code and migrate off of the dep-server will be completed in a separate issue once workflows and infrastructure is set up.

We now have builds from the Dep Server available:

https://api.deps.paketo.io/v1/dependency?name=rust

These builds are custom compilations of Rust with docs & development features stripped out. It's essentially like running the installer with the --without=rust-docs,rls-preview,clippy-preview,miri-preview,rustfmt-preview,llvm-tools-preview,rust-analysis-x86_64-unknown-linux-gnu argument.

The rationale for this as opposed to the standard installer:

• this is smaller, about 100M less needs to be downloaded
• the install process is simpler for the buildpack, just extract the files. No script to run.
• there's less disk i/o required as we're not downloading a large installer, extracting all of it (which was like 1.2G) then copy/installing 500M of that elsewhere.

The naming convention in Paketo is to not use the -cnb suffix. We should change the name of this repository to align with that naming convention.

We should add integration tests that verify that rust is reliably installed onto the system.

Use packit.Run instead of having two separate executables.

Allow selecting a version of Rust to be installed with the env variable BP_RUST_VERSION. Ex: BP_RUST_VERSION=1.50.0.

While you can select any version, you are limited to using versions that are available in buildpack.toml.

Add support for including a bill of materials