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

pcli installation instructions don't have copy-pastable code for MacOS #4255

Closed
hdevalence opened this issue Apr 22, 2024 · 1 comment · Fixed by #4282
Closed

pcli installation instructions don't have copy-pastable code for MacOS #4255

hdevalence opened this issue Apr 22, 2024 · 1 comment · Fixed by #4282
Assignees
Labels
A-docs Area: Documentation needs for the project _P-critical Priority: critical _P-high High priority _P-V1 Priority: slated for V1 release
Milestone

Comments

@hdevalence
Copy link
Member

Describe the bug

pcli is more difficult to install on MacOS because the instructions aren't copy-pastable: only Linux commands are provided.

It would be better if the guide had a separate block with copy-pastable MacOS instructions.

@github-project-automation github-project-automation bot moved this to Backlog in Penumbra Apr 22, 2024
@github-actions github-actions bot added the needs-refinement unclear, incomplete, or stub issue that needs work label Apr 22, 2024
@aubrika aubrika added _P-V1 Priority: slated for V1 release and removed needs-refinement unclear, incomplete, or stub issue that needs work labels Apr 22, 2024
@aubrika aubrika added this to the Sprint 5 milestone Apr 22, 2024
@conorsch conorsch added the A-docs Area: Documentation needs for the project label Apr 22, 2024
@conorsch conorsch self-assigned this Apr 22, 2024
@aubrika aubrika added the _P-high High priority label Apr 22, 2024
@aubrika aubrika moved this from Backlog to Todo in Penumbra Apr 22, 2024
@aubrika aubrika added the _P-critical Priority: critical label Apr 22, 2024
@conorsch
Copy link
Contributor

Closely related to #4256. We can definitely provide copy/paste functionality. I'm testing newer versions of cargo-dist in a private fork, and there's an opt-in for generating a copy/pasteable one-liner that pulls down a shell script and installs ad-hoc. We don't need msi support, since Windows isn't an install target for us, so the single shell script should work well for both macos and linux. If not, we can still write our own copy/pastable docs, as we do already.

conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4231
* closes #4255
* closes #4256
conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4231
* closes #4255
* closes #4256
conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4195
* closes #4255
* closes #4256
conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4195
* closes #4255
* closes #4256
@github-project-automation github-project-automation bot moved this from Todo to Done in Penumbra Apr 29, 2024
conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4195
* closes #4255
* closes #4256

(cherry picked from commit 36280c4)

Involved some manual conflict-resolution, particularly around RUSTFLAGS,
preserving the overrides since we haven't dropped the requirement for
the tokio unstable flag in the release branches yet.

ci: fix rust-toolchain.toml in container

Follow-up to #4282, ensuring that the rust-toolchain.toml makes it into
the container image, otherwise it'll throw an error on image build.
Observed this on the post-merge preview deploy.

(cherry picked from commit 8d3f4f9)
conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4195
* closes #4255
* closes #4256

(cherry picked from commit 36280c4)

Involved some manual conflict-resolution, particularly around RUSTFLAGS,
preserving the overrides since we haven't dropped the requirement for
the tokio unstable flag in the release branches yet.

ci: fix rust-toolchain.toml in container

Follow-up to #4282, ensuring that the rust-toolchain.toml makes it into
the container image, otherwise it'll throw an error on image build.
Observed this on the post-merge preview deploy.

(cherry picked from commit 8d3f4f9)
conorsch added a commit that referenced this issue Apr 29, 2024
Bumps the cargo-dist dependency, and regenerates the relevant CI files.
Tested these changes in a private fork, so we can be confident they
won't break builds.

Motivated by deprecation warnings in cargo-dist declaring that pinning
rust versions should use `rust-toolchain.toml`, updated ours to pin
1.75. Standardizing on the toolchain file lets us remove repeated
versions from a few different places, such as the containerbuild.
Removed custom action helpers from Rust CI workflows, because GHA
runners already come with rustup, and will honor the toolchain file.
This change ensures that our dev, build, and test environments all
use the same version of rust, which should minimize surprises like we
saw in #4231.

Included in the release artifacts now is a complete source tarball
with associated checksum, as requested in #4195. We're also distributing
binaries compressed as .tar.gz, rather than .tar.xz, to satisfy #4256,
and opting into a custom install script to satisfy #4255. Therefore:

* closes #4195
* closes #4255
* closes #4256

(cherry picked from commit 36280c4)

Involved some manual conflict-resolution, particularly around RUSTFLAGS,
preserving the overrides since we haven't dropped the requirement for
the tokio unstable flag in the release branches yet.

ci: fix rust-toolchain.toml in container

Follow-up to #4282, ensuring that the rust-toolchain.toml makes it into
the container image, otherwise it'll throw an error on image build.
Observed this on the post-merge preview deploy.

(cherry picked from commit 8d3f4f9)
conorsch added a commit that referenced this issue Apr 29, 2024
Refs #4288, #4284. Ports the latest tooling commit
to the guide. Updates the installer logic to make use of the new
cargo-dist installer scripts, so that macOS instructions are
copy/pasteable in the guide (#4255) and use .tar.gz for archive format
(#4256). I opted to leave the pd instructions largely as they are.
conorsch added a commit that referenced this issue Apr 30, 2024
Refs #4288, #4284. Ports the latest tooling commit
to the guide. Updates the installer logic to make use of the new
cargo-dist installer scripts, so that macOS instructions are
copy/pasteable in the guide (#4255) and use .tar.gz for archive format
(#4256). I opted to leave the pd instructions largely as they are.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation needs for the project _P-critical Priority: critical _P-high High priority _P-V1 Priority: slated for V1 release
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants