infrastructure/CONTRIBUTE.md
sinavir 0e95b3b375
All checks were successful
build configuration / build_compute01 (pull_request) Successful in 55s
build configuration / build_storage01 (pull_request) Successful in 51s
build configuration / build_vault01 (pull_request) Successful in 48s
build configuration / build_web01 (pull_request) Successful in 1m15s
build configuration / build_web02 (pull_request) Successful in 49s
build configuration / build_rescue01 (pull_request) Successful in 46s
build configuration / build_storage01 (push) Successful in 55s
build configuration / build_compute01 (push) Successful in 1m0s
build configuration / build_vault01 (push) Successful in 54s
lint / check (push) Successful in 26s
build configuration / build_web01 (push) Successful in 1m21s
build configuration / build_web02 (push) Successful in 51s
build configuration / build_rescue01 (push) Successful in 48s
feat(README): Add guidelines for contributions and doc for dev tools
2024-02-23 21:07:20 +01:00

1 KiB

Contribuer

Quelques éléments à savoir:

  • La branche main doit normalement suivre l'état des machines en production. Si vous ne déployez pas tout de suite faîtes une branche et une PR.
  • Les commits doivent passer le crochet de pre-commit (cf ci-dessous pour savoir comment l'installer)

Shell de développement et crochets pre-commit

Le dépot possède un shell de développement:

nix-shell

Pour installer les crochets, il suffit de lancer le shell de developpement une fois.

Lister les machines

Dans le shell de developpement, exécuter:

list-nodes

Lancer une vm de test

Dans le shell de developpement, exécuter:

launch-vm -p MACHINE

On peut faire du port forwarding (pour avoir accès à ssh par exemple) avec l'option -p HOSTPORT-:GUESTPORT.

Tester les versions en production

En attendant https://github.com/RaitoBezarius/mimir, on peut tester localement si c'est bien le dernier commit de main qui est déployé avec:

nix-shell --run 'check-deployment [NODE_NAME]'