GitHub issue artifact: Planlar için yorumların ötesinde kalıcı bir yer
Kod pull request içindeyken kararın nedeni eski bir sohbette kalabilir. Ajanın araştırması da başka yerdeyse işi devralan kişi tekrar başlayabilir. GitHub, 28 Ekim’de bu bağlamı doğrudan issue’ya ekleyen artifact özelliğini herkese açık önizlemeye sundu.
Sohbet ve yaşayan belge farklı işler yapar
Artifact; Markdown, dış bağlantı veya HTML belgesi olabilir: kök neden analizi, prototip, Slack ya da Teams konuşması gibi. github.com üzerinde sürüm geçmişi korunarak oluşturulup düzenlenebilir. Bunlar workflow çıktısı olan GitHub Actions artifact’larından ayrıdır.
İki kez işlenen hayali bir ödemeyi düşünelim. Yorumlar yeni gözlemleri, plan ise yeniden deneme anahtarını ve açık deneyleri kaydeder. İlk görsel bu yazı için hazırlanmış örnektir; GitHub ekranı değildir. Gözlem ve varsayımı ayırmak tahminin gereksinime dönüşmesini engellemeye yardımcı olur.
Dosyayı ekleyip aynı bağlamı sürdürmek
gh issue artifact create, issue numarası veya URL’sinden sonra dosya ya da bağlantı alır. gh issue artifact create 42 retry-plan.md -R OWNER/REPO dosyayı issue 42’ye eklerdi. Değerler örnektir; çalıştırmak issue’ya yazma işlemidir. Yazı için çalıştırılmadı.
Ad dosyadan alınabilir veya --name ile verilebilir. --body-file tek belgenin içeriğini okur, --attach görsel ve video destekler. gh issue artifact edit 42 1 --body-file retry-plan.md -R OWNER/REPO içeriği değiştirir. İkinci görsel başarılı yükleme kaydı değil, sözdizimi örneğidir.
Güncel planla geçmişi birlikte tutmak
edit ad veya içeriği değiştirir; türü değiştirmez. --restore-version eski ad ve içeriği yeni sürüm olarak kaydeder, view düzenleme geçmişini gösterir. Güncel planı korumak geçmiş kararı silmeyi gerektirmez.
Ödeme örneğinde şüphe zaman aşımından yinelenen anahtarların işlenmesine kayabilir. Planı güncelleyip açıklayan yorumu bağlamak bir dokümantasyon önerisidir; otomatik ürün davranışı değildir. Ekli belge kodun doğruluğunun yerini tutmaz.
HTML desteği kullanılan arayüze bağlı
Duyuru, HTML önizlemesi ve kaynak arasında geçişi anlatıyor. Ancak GitHub App içinde HTML oluşturma ve görüntüleme gelecekteki özellik olarak belirtiliyor. Oturum çıktılarının otomatik eklenmesi her yerde tam HTML desteği anlamına gelmez. CLI da önizlemedir.
Yarar, belge sayısından çok bağlamın işe yakın bulunmasıdır. Mevcut bir plan ve sonraki revizyonu akışı denemeye yeter. Güncel sınırlar aşağıdaki resmi kaynaklarda açıklanıyor.