diff --git a/utils/create-task-email.txt b/utils/create-task-email.txt index edfb107..b751854 100644 --- a/utils/create-task-email.txt +++ b/utils/create-task-email.txt @@ -1,26 +1,43 @@ -Dear {name}, + Dear {name}, You are receiving this email because you have a repository on c4science.ch that is bigger than 2GB. {repo_id} {repo_name}: {repo_size} -These repositories disrupt operations of the service as GIT and SVN are designed to manage source code in text format and not well suited to handle large binary files. Everything that can easily be re-generated should not be in a repository, for example machine code and intermediate files, PDFs, processed data sets, etc. An acceptable utilisation is image files if they are not too big (a few MB at most). +These repositories disrupt operations of the service as **version control systems are designed to manage source code in text format** and not well suited to handle large binary files. -If you need to store big files (>1MB) in your repository, please use the Git LFS (Large File Storage) service also provided by c4science: https://c4science.ch/w/c4science/lfs/ +**Files that can easily be re-generated should not be in a repository**, for example machine code and intermediate files, PDFs, processed data sets, etc. An acceptable utilisation is image files if they are not too big (a few MB at most). -Here are the actions you need to do on your repositories: +If you need to store big files (>10MB) in your repository, please use the Git LFS (Large File Storage) service also provided by c4science: https://c4science.ch/w/c4science/lfs/ -- If your repository contains multiple projects, please create new repositories for each project, split your main repository and we will then delete the former repository: https://c4science.ch/w/c4science/split/ -- Add .gitignore rules to filter temporary or generated files that should not be added to the repository: https://c4science.ch/w/c4science/gitignore/ -- If your repository contains binary files, things get more complicated. As files stay in the history even when you delete them this could potentially make the issue worse as they could appear twice. - - If you are the only contributor to this repository: You can use Git BFG to remove the files from the history and force push to remove all traces of the files: https://c4science.ch/w/c4science/lfs/#convert-already-commited - - If there are multiple people collaborating on the same repository BFG will be problematic. It rewrites the Git history and will prevent your coworkers from doing pull of the repository as their history would have diverged. You will need to coordinate with your coworkers so that they do a clean git clone after the use of Git BFG. +## Actions you need to do on your repositories -IMPORTANT: If we have no news from you and the repository size is not reduced before August 1st, 2018, we will have to deactivate it. After a grace period of 3 months the repository will be deleted. +### Split your repo + +If your repository contains multiple projects, please create new repositories for each project, split your main repository and we will then delete the former repository: https://c4science.ch/w/c4science/split/ + +### Ignore new files + +Add .gitignore rules to filter temporary or generated files that should not be added to the repository in the future: https://c4science.ch/w/c4science/gitignore/ + +### Remove existing files + +Files stay in the history even when you delete them, this could even potentially make the issue worse. + +- If you are the only contributor to this repository: You can use Git BFG to remove the files from the history and force push to remove all traces of the files: https://c4science.ch/w/c4science/lfs/#convert-already-commited + +- If there are multiple people collaborating on the same repository BFG will be problematic. It rewrites the Git history and will prevent your coworkers from doing pull of the repository as their history would have diverged -> You will need to coordinate with your coworkers so that they do a clean git clone after the use of Git BFG. + +IMPORTANT: If we have no news from you and the repository size is not reduced before March 1st, 2019, we will have to deactivate it. After a grace period of 3 months the repository will be deleted. + +## GIT and c4science courses Training on the use of c4science.ch and in particular the tools mentioned above is available regularly at EPFL and also on-demand for sufficiently large groups. +- https://scitas.epfl.ch/documentation/training/#git +- Contact scitas@epfl.ch for personalized c4science training + If you have any questions about how to proceed or any comment about the situation, please answer to this email or on the c4science task and we will help you with any concern. Kind Regards, c4science team