Belgelendirme ve Kendi Kendine Hizmet İş Akışları

Başarılı iş birliği, düzenli koddan fazlasına bağlıdır. Ekip arkadaşlarının bir modülün ne yaptığını, hangi girdileri beklediğini ve onu güvenle nasıl çalıştıracağını anlaması gerekir. Yaşayan belgeleme, bir depoyu kendi kendine hizmet veren bir araca dönüştürür.

Her Terraform deposu; amacı, ön koşulları, kullanım örneğini ve girdileri/çıktıları açıklayan bir README ile başlamalıdır. Yeni bir katkıcının okuyacağı ilk şey budur.

terraform-docs aracı değişkenlerinizi ve çıktılarınızı tarayarak bir Markdown tablosu oluşturur; böylece belgeler koddan hiçbir zaman kopmaz.

terraform-docs'un yalnızca belirli bir bölümü güncellemesi ve elle yazdığınız giriş kısmını koruması için işaretleyici yorumları kullanın.

Oluşturulan belgeler yalnızca description alanlarınız kadar iyidir. Bunları kullanıcıya yönelik metinler olarak ele alın.

Bir pre-commit çerçevesi, her commit işleminden önce kontrolleri çalıştırarak sorunların incelemeye ulaşmadan yakalanmasını sağlar. Bir YAML dosyasıyla yapılandırılır.

Kancaların commit sırasında otomatik olarak çalışması için yükleme komutunu her klon için bir kez çalıştırın.

Geçersiz örnek türleri gibi sağlayıcıya özgü hataları yakalamak için terraform fmt komutunu tflint gibi bir lint aracıyla birlikte kullanın.

Ekibinizin iş akışını bir CONTRIBUTING dosyasında belgeleyin: dal adlandırma kuralları, planın nasıl çalıştırılacağı ve apply işlemlerini kimin onaylayacağı. Bu, yeni katılanların tahminde bulunma ihtiyacını ortadan kaldırır.

ADR'ler, bir seçimin neden yapıldığını kaydeder (örneğin, neden uzak bir arka uç seçtiğiniz). Bunları depoda saklamak, özgün yazar ayrıldıktan çok sonra bile bağlamı korur.

Çalıştırılabilir mini yapılandırmalar içeren bir examples/ klasörü, kullanıcıların girdileri tersine mühendislikle çözmek yerine çalışan bir kurulumu kopyalamasını sağlar. Ayrıca tümleştirme testi materyali olarak da kullanılabilir.

Belgeleme araçları bilginizi sınayın.

İş birliğini sorunsuz hâle getirmeyi öğrendiniz:

• Güçlü bir README ve CONTRIBUTING rehberi.
• Otomatik oluşturulan girdi/çıktı tabloları için terraform-docs.
• fmt, validate ve lint çalıştıran pre-commit kancaları.
• Bağlamı ve kullanımı kaydeden ADR'ler ve örnekler.