feat(link): generate shims for missing 'bin' scripts #2059
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
During the 'link' step, if a package's binary targets don't exist yet they will fail to be symlinked, even if a later `run xxx` step would have generated them. This is a situation that occurs in monorepos containing build tools compiled from another language (e.g. TypeScript). Simply adding the symlinks whether the target exists or not is not good enough, as the symlink target needs to be `chmod +x`ed, which is lerna's/npm's responsibility. Instead, if the target doesn't exist, generate a shim shell script that will `chmod` and `exec` the intended target, similar to what would happen on Windows normally. Fixes #1444.
dgp1130
added a commit
to dgp1130/bxpb
that referenced
this pull request
May 24, 2020
Refs #1. CI appears to be failing, due to a missing `packages/bxpb-protoc-plugin/bin/bxpb-protoc-plugin` file. This is weird to me as the file is directly checked in to source. https://github.com/dgp1130/bxpb/runs/702931728 The symlink appears to work as expected after passing through a wrapper shell script from lerna/lerna#2059, and that script works correctly when used locally. While doing some investigation, I noticed an NPM best practice of using `#!/usr/bin/env node` for the shebang line. I'm hoping GitHub actions just has the Node binary in a different location and printed a very bad error message. Only one way to find out!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
During the 'link' step, if a package's binary targets don't exist yet
they will fail to be symlinked, even if a later
run xxxstep wouldhave generated them. This is a situation that occurs in monorepos
containing build tools compiled from another language (e.g. TypeScript).
Simply adding the symlinks whether the target exists or not is not good
enough, as the symlink target needs to be
chmod +xed, which islerna's/npm's responsibility.
Instead, if the target doesn't exist, generate a shim shell script that
will
chmodandexecthe intended target, similar to what wouldhappen on Windows normally.
Fixes #1444.
Motivation and Context
It solves an issue in our TypeScript-compiled monorepo that uses custom build tooling.
Also makes the behavior the same as if the packages had been published and pulled the packages from NPM independently.
How Has This Been Tested?
Added and ran integration test.
Types of changes
Checklist: