Système de publication des projets d'étudiants (projets de semestre, travaux de diplômes et projets de master) à la Haute école d'ingénierie et d'architecture de Fribourg.
Voici la marche à suivre pour proposer des projets:
-
Créer un projet sur https://gitlab.forge.hefr.ch/, dans le groupe "travaux-etudiants-isc/prénom_nom" qui a été crée pour vous.
-
Pour chaque projet, rédiger un fichier avec l'extension
.md. Ce fichier se compose de deux parties:- Un "front matter" en YAML avec les méta données du projet. Cette partie doit respecter le schéma Kwalify suivant : https://gitlab.forge.hefr.ch/damien.goetschi/projetu/-/blob/master/projetu/schemas/meta_v3.yml
Liste des champs:
Nom du champ Obligatoire? Type version Oui int academic_year Oui string format 2021/2022 type Oui enum (ps5, ps6 ou tb) title Oui string departments Oui liste de string
valeurs possibles:
- Informatique
- Télécommunications
- ISC
- Informatique et Systèmes de Communicationlanguages Oui liste de string
valeurs possibles: D, F et Econfidential Oui boolean (True/False) max_students Oui int (1 ou 2) continuation Oui boolean (True/False) abbreviation Non string orientations Non liste de string
valeurs possibles:
- Internet et communication
- Réseaux et sécurité
- Informatique logicielle
- Réseaux et Systèmes
- Ingénierie des donnéesprofesssors Non liste de string assistants Non liste de string mandantors Non liste de string instituts Non liste de string
valeurs possibles: HumanTech, iCoSys, iSIS, ENERGY, ChemTech, iPrint, iRAP, iTEC, SeSi et TRANSFORMrealized Non string
valeurs possibles: labo, entreprise, étranger et instituts externekeywords Non liste de string assigned_to Non liste de string weight Non int - La donnée du projet en markdown avec des sections telles que "Contexte", "Objectifs", "Contraintes".
Voici un exemple pour un tel fichier
--- version: 3 title: Mon super projet type: tb academic_year: 2021/2022 departments: - Informatique - Télécommunications orientations: - Internet et communication max_students: 1 professors: - Philippe Joye keywords: [IoT, Réseaux, Machine Learning] languages: [F] confidential: False continuation: False --- ## Contexte Sit sint sit adipisicing excepteur cillum ullamco velit qui fugiat occaecat. Voluptate aliqua ex commodo aliqua commodo exercitation quis minim exercitation qui minim dolor. ## Objectifs - Lorem ipsum - Dolor sit - Consectetuer - Adipiscing elit ## Contraintes - Diam - Nonummy nibh - TinciduntPour insérer une image, ajoutez l'image à votre projet et faites-y référence de la manière suivante (par exemple ici avec une image qui prendra 70% de la largeur du texte) (pour être centrée l'image doit avoir une légende mais on peut "tricher" en y mettant une espace insécable
):{width=70%} - Un "front matter" en YAML avec les méta données du projet. Cette partie doit respecter le schéma Kwalify suivant : https://gitlab.forge.hefr.ch/damien.goetschi/projetu/-/blob/master/projetu/schemas/meta_v3.yml
Liste des champs:
-
Définissez un fichier
.gitlab-ci.ymlavec le contenu suivant:
image: "registry.forge.hefr.ch/damien.goetschi/projetu:latest"
build:
script:
find . -type f -name '*.md' -and -not -name 'README*' -print0 | xargs -0 projetu --author="$GITLAB_USER_NAME" --template=v2.md --academic-year=2021/2022 --type=tb
artifacts:
paths:
- ./*.pdf- A chaque fois que vous ferez un
git commitet que vous enverrez les changements sur gitlab (avec ungit push), le CI/CD de gitlab produira les PDFs correspondants à vous fichiers. Assurez-vous que la compilation ne produise pas d'erreur.
le projet https://gitlab.forge.hefr.ch/jacques.supcik/ps6-2019-2020 montre comment le système fonctionne.
Il y a la description de deux projets avec des images.
Pour voir le résultat, allez sur https://gitlab.forge.hefr.ch/jacques.supcik/ps6-2019-2020/pipelines, puis cliquez sur le "vu" vert, puis sur "build":
Ensuite cliquez sur "browse":
Et vous verrez le résultat (pdf) de vos fichiers:
Si vous souhaitez obtenir le PDF sans passer par le CI/CD de gitlab, vous pouvez utiliser l'image Docker de la manière suivante:
- Installer Docker si vous ne l'avez pas encore
- Télécharger l'image Docker pour projetu
docker login registry.forge.hefr.ch docker pull registry.forge.hefr.ch/damien.goetschi/projetu - Compiler vos fichiers
ou alors, pour un seul fichier à la fois:
docker run --rm -ti -v $(pwd):/src -w "/src" \ registry.forge.hefr.ch/damien.goetschi/projetu \ bash -c "ls *.md | grep -v README | xargs \ projetu --author=\"$(whoami)\" \ --template=tb.md \ --config /app/tb-2019-2020.yml \ --academic-year=2021/2022 --type=tb"docker run --rm -ti -v $(pwd):/src -w "/src" \ registry.forge.hefr.ch/jacques.supcik/projetu \ projetu --author="MY NAME" \ --template=tb.md --config /app/tb-2019-2020.yml \ --academic-year=2021/2022 --type=tb \ MY_PROJECT_FILE.md
Vous pouvez aussi faire sans Docker, mais il vous faudra installer tous les logiciels sur votre machine : LaTeX, Pandoc, Python 3, ainsi que le code pour projetu.
Depuis la version 11.9.4 de gitlab, le téléversement d'image au travers de l'interface web (et également avec le WebIDE) modifie les métadonnées des images:
Ceci à pour conséquence de "casser" LaTeX lorsque ces images sont utilisées. Ca se traduit souvent par une erreur du genre :
! Package graphics Error: Division by 0.
See the graphics package documentation for explanation.
Type H <return> for immediate help.
...
l.xxx ...{img/figure.jpg}
Si vous utilisez le WebIDE de gitlab et si vous avez ce genre d'erreur, vous
pouvez y remédier en corrigeant les images dans le pipeline du CI/CD à l'aide du programme exiftool (inclu dans l'image Docker à partir de la version 0.1.2)
votre .gitlab-ci.yml pourrait alors ressembler à ça:
image: "registry.forge.hefr.ch/damien.goetschi/projetu:latest"
build:
script:
ls img/* | xargs exiftool -jfif:Xresolution=300 -jfif:Yresolution=300 -jfif:ResolutionUnit=inches
ls *.md | grep -v README | xargs projetu --author="$GITLAB_USER_NAME" --template=tb.md --config /app/tb-2019-2020.yml
artifacts:
paths:
- ./*.pdf