MNT: Add symbolic link to environment.yml for user clarity #104
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
To make it easier for users who are not used to binder but maybe used to typical Conda workflows, add a symbolic link from binder/environment.yml to environment.yml in the top level of the repository. This partially reverts parts of PR 85.
To ensure that everything is uniform across the repository, use the symobolic link to the 'binder/environment.yml' that is in the top level of the repository.
|
@ericmjl @hugobowne this is ready for review, though perhaps we should get the CI running in another PR and then come back and rebase this once that is done. Though as it seems the CI isn't supporting Windows I don't think we need to be worried about symbolic links failing there so this should be fine if you want to visually review only. |
ericmjl
approved these changes
Jul 11, 2022
|
Gentle ping on this to see if there is anything else that needs to get done before merge. |
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.
This PR partially reverts things I did in PR #85. To make it easier for users who are not used to binder but maybe used to typical Conda workflows, add a symbolic link from
binder/environment.ymltoenvironment.ymlin the top level of the repository. Additionally, change all instances ofbinder/environment.ymltoenvironment.yml(that is, rungit grep --name-only "binder/environment.yml" | xargs sed -i 's|binder/environment.yml|environment.yml|g').
This does not fully revert the work of PR #85 though, as Binder will always look for config files under the
binder/directory in a repository if the directory exists. So this is more of a way to keep Binder config clear but also make things easier/clearer for users.For an example of this behavior, c.f. phinate/differentiable-analysis-examples#1.