Skip to content
Snippets Groups Projects

Update README.md

Merged Update README.md
eva.furrer-master-patch-50740 into master
Merged Reto Gerber requested to merge eva.furrer-master-patch-50740 into master
Compare
and
1 file
+ 2
− 8
Compare changes
  • Side-by-side
  • Inline
README.md
+ 2
− 8
@@ -48,6 +48,7 @@ Then run code/setup_tests.R which will create all the test files in "docker/test
@@ -48,6 +48,7 @@ Then run code/setup_tests.R which will create all the test files in "docker/test
## Docker / Gitlab Container Registry
## Docker / Gitlab Container Registry
 
We set up CI/CD capabilities of gitlab such that whenever someone pushes changes to the course repository automatic tests are done.
To deploy the new tests, a new docker container needs to be created and pushed which will be explained in the following.
To deploy the new tests, a new docker container needs to be created and pushed which will be explained in the following.
To build the Docker container you need to [install Docker](https://docs.docker.com/engine/install/). Then you have to modify the Dockerfile [docker/Dockerfile](Dockerfile) to contain all the needed packages. Adjust the list as you need. Furthermore, if students use other packages than the ones you installed they can create a file called `packages.txt` (in each homework directory) where they can list packages, one per line and without quotes. For an example see [packages.txt](packages.txt).
To build the Docker container you need to [install Docker](https://docs.docker.com/engine/install/). Then you have to modify the Dockerfile [docker/Dockerfile](Dockerfile) to contain all the needed packages. Adjust the list as you need. Furthermore, if students use other packages than the ones you installed they can create a file called `packages.txt` (in each homework directory) where they can list packages, one per line and without quotes. For an example see [packages.txt](packages.txt).
@@ -73,18 +74,11 @@ docker push cr.gitlab.uzh.ch/NAMESPACE/COURSE_PROJECTNAME/rmd_tests:latest
@@ -73,18 +74,11 @@ docker push cr.gitlab.uzh.ch/NAMESPACE/COURSE_PROJECTNAME/rmd_tests:latest
The container is now ready to be used in CI/CD in the course repository.
The container is now ready to be used in CI/CD in the course repository.
To setup CI/CD in the course repository you have to enable shared runners in the CI/CD setting of your course repository. Next you can copy the file [.gitlab-ci.yml](.gitlab-ci.yml) from the test repository to the course repository. You have to replace `NAMESPACE` with the name of your course repo and `COURSE_PROJECTNAME`with your username or groupname at the top of the file (row 5, under the tag `image`).
To setup CI/CD in the course repository you have to enable shared runners in the CI/CD setting of your course repository (as described [here](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#enable-shared-runners-for-a-project)). Next you can copy the file [.gitlab-ci.yml](.gitlab-ci.yml) from the test repository to the course repository. You have to replace `NAMESPACE` with the name of your course repo and `COURSE_PROJECTNAME`with your username or groupname at the top of the file (row 5, under the tag `image`).
The name of the created container is `rmd_tests`. If you want to change this name replace `rmd_tests` with a name of your choice in the above commands and also change it in the [.gitlab-ci.yml](.gitlab-ci.yml) file at the top of the file.
The name of the created container is `rmd_tests`. If you want to change this name replace `rmd_tests` with a name of your choice in the above commands and also change it in the [.gitlab-ci.yml](.gitlab-ci.yml) file at the top of the file.
## CI/CD
There is one more setting that needs to be made on gitlab: enable shared runners (as described [here](https://docs.gitlab.com/ee/ci/runners/runners_scope.html#enable-shared-runners-for-a-project)).
Now whenever someone pushes changes to the course repository automatic tests are done.
## Final step
## Final step
As a final step make sure to have all the adjustments you made added to gitlab (i.e. commited and pushed).
As a final step make sure to have all the adjustments you made added to gitlab (i.e. commited and pushed).