How to

How to put in place the script

Considering you're using Git and Github Classroom to make the students create their repository, this short tutorial will help you put in place the use of the g4s-automation script for your practical work sessions.

In your Github Classroom repository, you have to :

• Add the 3 executables of the script (to make it available for students working on one of the 3 main OS)
• Add a minimal .settings.yml configuration file (generated when the script is first used) containing :
  • repo_path (. by default, should not be modified a priori) : the repository to observe with the script
  • ssh_path ("home"/.ssh/id_rsa by default, path by default when creating an ssh key) : the path to the ssh key linked to the right Github account. You can leave the default path generated, it will be up to the student to change it if it is different
  • questions : all the questions to be answered in the lab topic
  • groups : the TP groups you manage (currently useless, it is not useful to fill it more than with an empty list)
• Adapt the TP subject if necessary to indicate to "fix" each question with the subject
• Add an introduction to explain the script in the worksheet, how it works and some safety instructions:
  • Do not close the script other than with the exit command
  • Do not modify the repository without having the script open (changes made outside the script will be deleted when it is launched)
  • Don't forget to pull before launching the script if there are possible changes elsewhere