Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include the rustup target add step in the cross-compile assistance text #729

Merged
merged 1 commit into from
Nov 9, 2023

Conversation

edmorley
Copy link
Member

@edmorley edmorley commented Nov 9, 2023

In order to compile buildpacks, users need to have both the musl toolchain and the Rust target installed.

If the musl toolchain is missing, we already show help text that says what packages need to be installed.

However, this help text does not mention the Rust target, meaning after installing the musl tools, users will then go on to receive another error - this time from the Rust compiler.

Whilst the Rust compiler error message does suggest running the rustup target add command itself:

Now, the cross-compile assistance help text also suggests the rustup target add step, improving the UX slightly.

The help texts are starting to include a fair bit of duplication, however, refactoring is covered by the separate #727.

Fixes #716.
GUS-W-14438920.

…text

In order to compile buildpacks, users need to have both the musl
toolchain and the Rust target installed.

If the musl toolchain is missing, we already showed help text that
says what packages need to be installed.

However, this help text did not mention the Rust target, meaning
after installing the musl tools, users would then go on to receive
another error - this time from the Rust compiler.

Whilst the Rust compiler error message does suggest running the
`rustup target add` command itself:
- this suggestion is often lost in the noise:
  rust-lang/rust#117640
- it means the users has had two failed attempts in a row, which
  could make the experience feel open-ended/frustrating

Now, the cross-compile assistance help text also suggests the
`rustup target add` step, improving the UX slightly.

The help texts are starting to include a fair bit of duplication, however,
refactoring is covered by the separate #727.

Fixes #716.
GUS-W-14438920.
@edmorley edmorley added enhancement New feature or request libcnb-package labels Nov 9, 2023
@edmorley edmorley self-assigned this Nov 9, 2023
@edmorley edmorley marked this pull request as ready for review November 9, 2023 11:37
@edmorley edmorley requested a review from a team as a code owner November 9, 2023 11:37
@edmorley edmorley merged commit 581ed73 into main Nov 9, 2023
6 checks passed
@edmorley edmorley deleted the edmorley/cross-compile-help-add-target branch November 9, 2023 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request libcnb-package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention the rustup target add step in the initial cross-compile assistance message
2 participants