m2cci / m2cci-2425-gl-public

1 stars 0 forks source link

[MiseEnRoute] VisionGlobale #1

Open xcriptus opened 1 month ago

xcriptus commented 1 month ago

Cette première issue donne une vision globale sur le processus de mise en route.

Intégration d'outils

Le processus qui suit, et globalement l'enseignement dispensé dans ce cours, et basé sur l'utilisation dans différents outils professionnels. Trois outils, en particulier, constituent le "système d'information" pour l'enseignement :

Mattermost, GitHub et Coda sont fortement couplés<. D'un point de vue technique ils sont intégrés via des APIs, sous forme de services web. Un robot, "ScribesGit", effectue différentes tâches, entre autre certaines tâches d'évaluation. Avec une telle infrastructure, il est ABSOLUMENT INDISPENSABLE de respecter un certain nombre de règles, pour que les informations fournies dans Coda, par exemple, soient alignées avec GitHub et Mattermost. Sans cela, les différents systèmes ne pourront pas communiquer.

image

Processus de mise en route

Le schema ci-dessous donne une vision globale du processus de mise en route. D'un point de vue concret chaque étape du processus est décrite dans une issue GitHub. Toutes les issues sont numérotées à partir de #1. Il est IMPERATIF d'exécuter ces issues dans l'ordre croissant. ATTENTION : par défaut, dans GitHub, les premières issues sont en bas de l'écran. Utiliser l'option Sort si nécessaire.

Selection_999(326)

Les premières étapes de la mise en route (à gauche dans l'image) sont dans ce dépot public. Les étapes suivantes (à droite) ne seront visible qu'une fois que vous aurez constitué, avec un ou d'autres étudiants, un groupe complet. Ces issues sont en effet associées à ce groupe particulier.

Etape 1

Dans cette partie, on décrit uniquement les issues publiques, les issues à réaliser pour la livraison 1. Ces issues, à gauche dans l'image, de bas en haut, consistent essentiellement à :

Une fois ces différentes étapes effectuées, une fois le groupe complet, l'enseignant validera chaque groupe. Vous recevrez ensuite une invitation GitHub.

La première étape se termine lorsque tous les membres du groupe ont rejoint le groupe Github.

Livraisons

À la fin de chaque étape correspond une livraison, numérotée L1, L2, L3, etc., suivie généralement d'une évaluation. Selon les cas, cette évaluation sera, en tout ou partie, assurée par le robot XcribesBot. Il est INDISPENSABLE de suivre les consignes fournies dans les issues à la lettre. Par exemple tout code, ou toute figure n'étant pas à la place spécifiée, sera comptée comme absente dans l'évaluation. À chaque issue est associée une livraison ("release" dans la terminologie GitHub). La livraison apparaît juste en dessous du titre de l'issue.

Selection_999(330)

NOTE : En fait, en fin de chaque étape, il n'y a rien à "livrer", rien à faire. A la date et l'heure spécifiées par la livraison, le robot consultera les éléments que vous aurez fournis dans les emplacements prévus (dépot GitHub, documents Coda, etc.).

image

Nomenclature

L'intégration d'outils et l'automatisation des tâches passe par le respect d'une nomenclature stricte.

Dans les tâches qui suivent les URLs indiquées devront être adaptées à votre contexte. Une URL peut être par exemple :

https://github.com/m1exo/m1exo-2425-sx-G99

L'URL comprend les éléments suivants (exemple fictif) :

Une fois adaptée à votre contexte l'URL ci-dessus pourrait ressembler à ceci :

https://github.com/m2gi/m2gi-2324-idm-G04

Dans certains cas le nom et le login github de l'utilisateur intervient. On supposera que l'utilisateur est Noe ZARWIN et que son login à l'Université est zarwinn.

Pensez dans les tâches suivantes à remplacer les éléments mentionnés ci-dessus.

Le plus simple est de noter sur un papier les substitutions pour les chaînes de caractères suivantes

Notez que dans la grande majorité des cas, il vous est demandé de vous inscrire aux différents services en utilisant votre email UGA (p.e. zoe.zarwin@univ-grenoble-alpes.fr)