first-render-document tutorial may not run on macOS after a plain cargo build
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- macos, rust
- Domain
- documentation, operating-systems
Research direction
Start with docs/site/src/content/docs/tutorials/first-render-document.mdx and inspect scripts/cargo-runtime-library-path.sh. On macOS, test whether target/release/registry-render runs after the plain Cargo build; if not, follow the helper-based build approach used by the Discovery tutorial. Done means the tutorial works on macOS and Linux, or records that registry-render does not need the helper.
Written by the indexing model from the issue text.
Description
Problem
docs/site/src/content/docs/tutorials/first-render-document.mdx tells the reader to build with a plain cargo build --release --locked -p registry-render and then run the binary directly. On macOS, a Cargo-built binary that links AWS-LC FIPS cannot run outside Cargo. The library stays in Cargo's build directory, and the binary fails with dyld: Library not loaded: @rpath/libaws_lc_fips_0_14_2_crypto.dylib. #1612 fixed the same problem on the Discovery tutorial.
Unverified: whether registry-render links AWS-LC FIPS at all. If it does not, this issue can be closed.
Proposal
Check on macOS whether target/release/registry-render runs from a shell after a plain build. If it doesn't, build the way the Discovery tutorial now does:
. scripts/cargo-runtime-library-path.sh
registry_cargo_build "$PWD" --locked --release -p registry-render
registry_cargo_build is plain cargo build on Linux and exports DYLD_FALLBACK_LIBRARY_PATH for the current shell on macOS. Every command that runs the binary must stay in that shell.
Done when
The tutorial's build step works as written on macOS and Linux, or this issue records that registry-render does not need the helper.
- Dominant language
- Rust
- Stars
- 2
- Forks
- 0
- Avg merge
- 8h 10m
- Merged PRs (30d)
- 222
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from registrystack/registry-stack
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
registrystack/registry-stack#1753 ·
Maintainers usually reply within 1 day
-
area:casework bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
registrystack/registry-stack#1729 ·
Maintainers usually reply within 1 day
-
area:breg bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
registrystack/registry-stack#1682 ·
Maintainers usually reply within 1 day
-
area:casework bug criticality:p3 triage:needs-implementation
Difficulty 1/5 Under an hour Newbie friendliness 88/100
registrystack/registry-stack#1669 ·
Maintainers usually reply within 1 day
-
agent-ready area:platform criticality:p3 documentation triage:needs-implementation
Difficulty 1/5 Under an hour Newbie friendliness 90/100
registrystack/registry-stack#1639 ·
Maintainers usually reply within 1 day
All issues in registrystack/registry-stack
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
aws-samples/sample-pacer#76 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
axodotdev/cargo-dist#2523 ·
Maintainers usually reply within 2 days