fix!: env.sh sourceable should not be in $PATH
#303
Merged
Conversation
This file contains hidden or 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
c-dilks
commented
Jul 30, 2024
Having `env.sh` in one's `$PATH` means that when some shells run `source env.sh` from anywhere, it may prioritize the `env.sh` from the `coatjava` installation, rather than the `env.sh` in the caller's present working directory. Since both `coatjava`'s `env.sh` and the caller's `./env.sh` may be silent, this can lead to confusion as to why the local `./env.sh` is not working. This PR moves `env.sh` to `libexec/`, which should not be in one's `$PATH`. Any downstream code which calls `source env.sh` may be affected, which is why the conventional commit label is `fix!` rather than `fix` (_i.e._, potential breaking change).
Collaborator
|
Note, this means the old CLARA installer will not result in a working COATJAVA installation. But that's acceptable since it also doesn't provide a working CLARA anymore. |
baltzell
approved these changes
Aug 13, 2024
baltzell
approved these changes
Aug 13, 2024
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.
Having
env.shin one's$PATHmeans that when some shells runsource env.shfrom anywhere, it may prioritize theenv.shfrom thecoatjavainstallation, rather than theenv.shin the caller's present working directory. Since bothcoatjava'senv.shand the caller's./env.shmay be silent, this can lead to confusion as to why the local./env.shis not working.This PR moves
env.shtolibexec/, which should not be in one's$PATH. Any downstream code which callssource env.shmay be affected, which is why the conventional commit label isfix!rather thanfix(i.e., potential breaking change).