Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setting course directory #362

Open
kcranston opened this issue Feb 3, 2021 · 2 comments
Open

setting course directory #362

kcranston opened this issue Feb 3, 2021 · 2 comments

Comments

@kcranston
Copy link
Collaborator

We would like to be able to put the course directory for an abc-classroom course into version control. This means sharing the same config file, which currently stores the full path to the course directory. Since the path will not be the same on different machine, we would prefer to avoid requiring the full path in the config. We may be able to just assume that the user is always invoking abc scripts from within the course directory, and throw an error if we don't find a config file in the current working directory.

Caveats:

  • abc-quickstart runs in the parent directory of the course directory
  • When testing with pytest, abc-classroom commands are not invoked from the course directory (but I think the way I implemented the tests and the read / write methods for the config makes this possible)
@kcranston
Copy link
Collaborator Author

If we want to support having the course directory in version control, we should also remove all the parts in the template config.py where we warn people that none of the parents of template_dir, clone_dir, etc should be git repos.

@kcranston
Copy link
Collaborator Author

We should add some notes to the documentation about sharing course repos in version control and the things that can be tricky:

  • relative / absolute paths
  • nested git repos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants