Penataan Kode
  • Contoh dan modul Terraform sebaiknya disertai dengan dokumentasi yang menjelaskan fitur-fitur dan cara penggunaannya.
  • Semua tautan pada berkas README.md sebaiknya menggunakan tautan absolut sehingga tautan akan ditampilkan dengan benar pada halaman Terraform Registry.
  • Dokumentasi bisa diisi dengan diagram yang dibuat menggunakan mermaid dan cetak biru buatan cloudcraft.co.
  • Gunakan kait-kait pre-commit Terraform untuk memastikan kode valid, diformat dengan benar, dan terdokumentasi secara otomatis sebelum dikirim ke git dan ditinjau oleh orang lain.

Dokumentasi

Dokumentasi secara otomatis

pre-commit merupakan kerangka kerja untuk mengelola dan memelihara kait pre-commit multi bahasa. Pre-commit ditulis dalam bahasa Python dan merupakan alat ampuh untuk melakukan sesuatu secara otomatis pada mesin pengembang sebelum kode disimpan pada repositori git. Umumnya alat ini digunakan untuk menjalankan linter dan memformat kode (Lihat kait yang didukung).
Kita bisa menggunakan pre-commit untuk memformat dan memvalidasi konfigurasi Terraform dan juga untuk memperbarui dokumentasi.
Periksa repository pre-commit-terraform untuk membiasakan diri Anda akan penggunaan pre-commit untuk Terraform. Beberapa repositori seperti terraform-aws-vpc sudah menggunakan pre-commit.

terraform-docs

terraform-docs merupakan alat untuk menciptakan dokumentasi modul Terraform dalam berbagai format keluaran. Kita dapat menjalankan terraform-docs secara manual (tanpa kait pre-commit) atau via kait pre-commit-terraform untuk memperbarui dokumentasi secara otomatis.
@todo: Dokumentasikan versi modul, rilis, dan GH actions

Sumber daya

Last modified 23d ago
Export as PDF
Copy link
Edit on GitHub