Διαμόρφωση κώδικα
Τα παραδείγματα και οι μονάδες Terraform θα πρέπει να περιέχουν ένα εγχειρίδιο που να εξηγεί τα χαρακτηριστικά και τον τρόπο χρήσης τους.
Όλοι οι σύνδεσμοι στα αρχεία README.md θα πρέπει να είναι απόλυτοι για να τους εμφανίζει σωστά η ιστοσελίδα του Terraform registry.
To εγχειρίδιο μπορεί να περιλαμβάνει διαγράμματα που δημιουργήθηκαν με το mermaid και σχέδια που δημιουργήθηκαν με το cloudcraft.co.
Χρησιμοποιήστε Terraform pre-commit hooks για να βεβαιωθείτε ότι ο κώδικας είναι έγκυρος, σωστά μορφοποιημένος και με αυτόματη καταγραφή εγχειριδίου πριν γίνει pushed στο git και ελεχγθεί από ανθρώπους.
Εγχειρίδιο
Αυτόματα παραγόμενο εγχειρίδιο
Το pre-commit είναι ένα framework για τη διαχείριση και τη συντήρηση πολυγλωσσικών pre-commit hooks. Είναι γραμμένο σε Python και είναι ένα ισχυρό εργαλείο για να κάνετε κάτι αυτόματα στο μηχάνημα ενός προγραμματιστή πριν ο κώδικας γίνει commit σε ένα git repository. Κανονικά, χρησιμοποιείται για την εκτέλεση linters και τη μορφοποίηση κώδικα (βλ. υποστηριζόμενα hooks).
Με τις ρυθμίσεις Terraform το pre-commit μπορεί να χρησιμοποιηθεί για τη μορφοποίηση και την επικύρωση κώδικα, καθώς και για την ενημέρωση τoυ εγχειριδίου.
Ελέγξτε το pre-commit-terraform repository για να εξοικειωθείτε με αυτό, καθώς και υπάρχοντα repositories (π.χ. terraform-aws-vpc) όπου αυτό χρησιμοποιείται ήδη.
terraform-docs
Το terraform-docs είναι ένα εργαλείο που κάνει τη δημιουργία εγχειριδίου από τις μονάδες Terraform σε διάφορες output μορφές . Μπορείτε να το εκτελέσετε χειροκίνητα (χωρίς pre-commit hooks) ή να χρησιμοποιήσετε pre-commit-terraform hooks για να ενημερώνεται αυτόματα το εγχειρίδιο.
@todo: Εκδόσεις εγγράφων μονάδων, έκδοση, ενέργειες GH
Πόροι
Last updated