Commit 99ff67ae authored by Enrique Garcia's avatar Enrique Garcia
Browse files

update README according to new version

parent ce5c2827
Pipeline #120780 passed with stages
in 2 minutes and 38 seconds
# template_project_escape
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3884963.svg)](https://doi.org/10.5281/zenodo.3884963)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4790629.svg)](https://doi.org/10.5281/zenodo.4790629)
[![pipeline status](https://gitlab.in2p3.fr/escape2020/wp3/template_project_escape/badges/master/pipeline.svg)](
https://gitlab.in2p3.fr/escape2020/wp3/template_project_escape/-/commits/master)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
......@@ -49,20 +49,28 @@ If you want to provide software to the ESCAPE repository:
- All the code provided should be uploaded to the [Zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
- Check the following [tutorial on how to publish content in Zenodo](https://escape2020.pages.in2p3.fr/wp3/ossr-pages/page/contribute/publish_tutorial/).
- Check the following [tutorial on how to publish content in Zenodo](https://escape2020.pages.in2p3.fr/wp3/ossr-pages/page/contribute/publish_tutorial/),
and how to automatise the upload of each new release of your project.
# Singularity image container and CI/CD to Zenodo
# This project also includes
A working example of how to;
## 1. How to automatise the building of a Singularity image and upload it to Zenodo using the GitLab-CI
A working example of how to automatise the GitLab-CI to;
1. create a Singularity image / container of your code,
2. make it available as a downloadable artifact within your project and
3. add it to the ESCAPE community in the [Zenodo repository](https://zenodo.org/communities/escape2020),
3. upload it to the [ESCAPE OSSR](https://zenodo.org/communities/escape2020),
can be found in the `.singularityci`, directory and in the `.gitlab-ci.yml` file. Please read carefully
all the README files.
can be found in the `.singularityci`, and `Singularity` directories and in the `.gitlab-ci.yml` file - the
`build_singularity_image` stage. Please read carefully all the README files.
For an easy example of how to create a Singularity receipt from scratch (and its corresponding container when executed),
please have a look to the `singularity_utils` directory.
please have a look to the `singularity_utils` directory.
## 2. How to automatise the building of a Docker container and upload it to the GitLab Container Registry
An example can be found in the `Docker` directory and in the `.gitlab-ci.yml` file - the
`build_docker_image` stage.
# Install
Example of how to show installing instructions (and indeed the way to install this project).
......@@ -77,12 +85,17 @@ Example of how to show installing instructions (and indeed the way to install th
Example of citing (as well as the DOI to cite this project),
In case of citing this repository, use the following DOI:
- v2.1 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4790629.svg)](https://doi.org/10.5281/zenodo.4790629)
- v2.0 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3884963.svg)](https://doi.org/10.5281/zenodo.3884963)
- v1.1 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3743490.svg)](https://doi.org/10.5281/zenodo.3743490)
- v1.0 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3572655.svg)](https://doi.org/10.5281/zenodo.3572655)
Do not forget to include your code / container into the [Zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
- ***Note that*** you will be able to assign a DOI in the moment you include your code/repository to Zenodo.
- ***Note that*** a DOI will be assigned in the moment create a new record/entry in Zenodo.
Please check the licenses of the code within in the `.singularityci` directory before adding this template
# License
Please check the licenses of the code within the `.singularityci` directory before adding this template
to your project.
# Report an issue / Ask a question
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment