- Notifications
You must be signed in to change notification settings - Fork277
MNT: Add symbolic link to environment.yml for user clarity#104
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
MNT: Add symbolic link to environment.yml for user clarity#104
Uh oh!
There was an error while loading.Please reload this page.
Conversation
To make it easier for users who are not used to binder but maybe used totypical Conda workflows, add a symbolic link from binder/environment.ymlto 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 thesymobolic link to the 'binder/environment.yml' that is in the top levelof the repository.
matthewfeickert commentedJul 11, 2022
@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. |
matthewfeickert commentedAug 10, 2022
Gentle ping on this to see if there is anything else that needs to get done before merge. |
Uh oh!
There was an error while loading.Please reload this page.
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.