Skip to content
Snippets Groups Projects
Commit b1e97bf3 authored by dylan.peiry's avatar dylan.peiry
Browse files

feat(README) ajout d'explications de fonctionnement

parent 2aec38e7
No related branches found
No related tags found
No related merge requests found
# Scripts
## gitcreate
Ce script automatise la création d'un nouveau projet sur le git de l'école à l'aide d'un **personal access token** et y pousse les fichiers du dossier courant.
### Générer un personal access token
Pour ce faire, vous devez vous rendre sur [Git HEPIA](https://gitedu.hesge.ch/profile/personal_access_tokens).
Ajouter un nouveau token en spécifiant le nom, la date d'expiration et en cochant la case **api** puis en cliquant sur le bouton **Create personal access token**.
Une fois le token généré, vous devez le mettre au début du script au niveau de la variable **ACCESS_TOKEN="your_token"**.
### Fonctionnement
Pour éxecuter le script, vous devez l'appeler en passant 3 paramètres :
- Votre login AAI (prenom.nom)
- Si vous souhaitez que le répertoire soit public ou non (true/false)
- La méthode d'accès (https/ssh)
Le nom du projet sera celui du répertoire courant depuis lequel vous lancez le script.
### Rendre le script accessible globalement
Pour pouvoir éxecuter le script depuis n'importe ou, vous devez le déplacer dans le dossier **bin**.
```
cp gitcreate.sh ~/bin/gitcreate
```
Vous pouvez maintenant l'éxecuter de la manière suivante.
```
gitcreate {loginAAI} {public:true,false} {method:https,ssh}
# Exemple
gitcreate dylan.peiry true ssh
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment