Status Dokumentasi
Status Dokumentasi
Kenali rilis Custy yang direpresentasikan situs ini dan tentukan kapan verifikasi khusus rilis diperlukan.
custyCategory
Quick Command
custy --versionBaseline saat iniโ
Halaman-halaman ini menjelaskan Custy v2.1.2 dan terakhir ditinjau terhadap source aktif pada 11 September 2026. Tanggal tersebut mencatat peninjauan dokumentasi yang disengaja, bukan tanggal edit Git atau deployment otomatis.
Custy menggunakan deteksi SemVer otomatis sesuai strategi tag repositori saat ini.
Bandingkan Versi yang Terpasang
custy --version- Jika perintah menampilkan
2.1.2, dokumentasi ini adalah baseline yang sesuai. - Jika versinya lebih lama, gunakan release notes dan tag source versi tersebut untuk mengenali fitur yang belum tersedia.
- Jika versinya lebih baru, tinjau rilis setelah
v2.1.2untuk command, option, configuration, perubahan perilaku, dan perbaikan baru. - Untuk versi pre-release atau post-release, bandingkan versi lengkap, termasuk
penanda seperti
alpha,beta,rc,dev, ataupost.
Gunakan rilis Custy dan
snapshot source v2.1.2
sebagai referensi khusus rilis.
Status Kesegaran
Features
Current
Outdated
Preview
Unknown
Referensi Konfigurasi
Pengaturan freshness berada pada entri proyek di src/data/projects.ts.
Pengaturan ini mengonfigurasi portal dokumentasi, bukan Custy CLI, sehingga
tidak ditempatkan di .config/custy/config.toml.Field dokumentasi bersama
Property Type Description Default Required versionstring Versi aplikasi ternormalisasi yang direpresentasikan halaman, tanpa mewajibkan prefiks v. - Yes versionTagstring Tag repositori untuk rilis yang didokumentasikan, misalnya v2.1.2. - Yes lastReviewedYYYY-MM-DD Tanggal maintainer meninjau dokumentasi terhadap source secara sengaja. - Yes releaseUrlURL Halaman rilis untuk baseline yang didokumentasikan. - Yes statusPathsite path Route independen locale menuju halaman status dokumentasi ini. - Yes freshness.modemanual | auto Pilih status yang dikendalikan maintainer atau deteksi remote tag saat build. - Yes Field mode otomatis
Property Type Description Default Required repositoryUrlGit URL Remote yang diperiksa dengan git ls-remote. URL HTTPS publik paling sederhana untuk CI. - Yes tagFormatsemver | pep440 Grammar versi untuk memvalidasi dan mengurutkan tag. Format custom sengaja tidak didukung. - Yes releasesUrlURL Tautan daftar rilis opsional ketika pengguna memerlukan versi lain. - No includePrereleasesboolean Sertakan tag alpha, beta, rc, dan development saat memilih versi terbaru. Post release PEP 440 tetap menjadi kandidat stabil. false No timeoutMsnumber Timeout pemeriksaan remote dari 1000 hingga 60000 milidetik. 10000 No fallbackStatuscurrent | unknown Status saat verifikasi otomatis gagal. Gunakan current hanya jika maintainer menerima fallback eksplisit tersebut. unknown No
Mode otomatisโ
documentation: {
version: "2.1.2",
versionTag: "v2.1.2",
lastReviewed: "2026-09-11",
releaseUrl: "https://github.com/devalltect00/Custy/releases/tag/v2.1.2",
statusPath: "/docs/custy/reference/documentation-status",
freshness: {
mode: "auto",
repositoryUrl: "https://github.com/devalltect00/Custy.git",
tagFormat: "semver",
releasesUrl: "https://github.com/devalltect00/Custy/releases",
includePrereleases: false,
timeoutMs: 10_000,
fallbackStatus: "unknown",
},
}
Mode manualโ
Gunakan mode manual untuk format versi custom, repositori yang tidak dapat dijangkau environment build, atau proyek yang status rilisnya memerlukan penilaian manusia.
freshness: {
mode: "manual",
status: "current", // current | outdated | preview
latestVersionTag: "custom-release-42", // opsional
}
Aturan Pemilihan Tag
- Periksa direct remote tag refs tanpa clone repositori.
- Hapus
refs/tags/, buang duplikat peeled^{}secara defensif, dan pertahankan tag asli untuk tampilan. - Terima prefiks
vkonvensional yang opsional. - Abaikan tag yang tidak sesuai grammar
semverataupep440terpilih. - Kecualikan prerelease kecuali
includePrereleasesbernilaitrue. - Urutkan tag kompatibel menggunakan grammar terpilih, bukan urutan teks.
Contohnya,
1.10.14diurutkan setelah1.10.9secara benar. - Bandingkan versi terbaru yang dinormalisasi dengan baseline dokumentasi.
Grammar tag custom tidak diterima dalam mode otomatis. Pilih mode manual alih-alih memperkirakan aturan pengurutan custom.
Penanganan Kegagalan
- Konfigurasi maintainer yang tidak valid, termasuk format yang tidak didukung, baseline tidak valid, URL remote kosong, atau timeout di luar rentang, akan menghentikan build dengan pesan yang dapat ditindaklanjuti.
- Git tidak tersedia, kegagalan jaringan, kegagalan autentikasi, dan timeout
tidak diam-diam menyatakan dokumentasi current. Plugin menggunakan
fallbackStatusdan mencetak peringatan build. - Pemeriksaan berhasil tanpa tag kompatibel menggunakan fallback yang sama
dengan kode diagnostik
no-compatible-tags. - Detail error remote tetap berada di log build; raw process error tidak ditampilkan kepada pengunjung dokumentasi.
- Pemeriksaan remote berjalan satu kali per proyek yang dikonfigurasi pada setiap proses Docusaurus, bukan satu kali per halaman.
Untuk repositori private, pastikan environment build dapat mengautentikasi Git
URL yang dikonfigurasi. Jangan menaruh credential atau token langsung di
src/data/projects.ts.
Deployment dan Otomatisasi Rilis
Deteksi otomatis dievaluasi ketika yarn start, yarn build, atau perintah
Docusaurus lain memuat plugin. Tag Custy baru tidak mengubah situs statis yang
sudah di-deploy sampai Devalltect Docs dibangun kembali.
Workflow Pages saat ini membangun ulang ketika ada push ke repositori
dokumentasi dan ketika workflow dijalankan manual. Integrasi berikutnya dapat
memicu build dokumentasi dari rilis Custy melalui repository_dispatch, atau
workflow terjadwal dapat memeriksa ulang tag secara berkala. Trigger workflow
tersebut terpisah dari freshness resolver.
Cakupan Baseline
Features
CLI Publik
Configuration
Internal Developer
Keterbatasan yang Diketahui
Pemeliharaan Dokumentasi
Maintainer perlu memperbarui baseline pusat ketika rilis Custy mengubah command, option, configuration, workflow, output, architecture, atau perilaku lain yang didokumentasikan dan terlihat oleh pengguna. Sinkronisasi lengkap mencakup:
- Tinjau tag rilis baru dan perilaku source aktif.
- Perbarui halaman bahasa Inggris yang terdampak.
- Terapkan perubahan teknis yang sama pada halaman bahasa Indonesia sambil mempertahankan nama command, option, path, configuration key, dan code.
- Ubah versi baseline, tag, URL rilis, dan tanggal terakhir ditinjau.
- Pastikan
tagFormattetap sesuai strategi SemVer repositori. - Jalankan freshness tests, type checking, dan production build untuk kedua locale.
Notifikasi global membaca satu entri metadata pusat dan hasil resolver saat build. Notifikasi disembunyikan ketika dokumentasi current dan hanya muncul ketika pengguna memerlukan konteks preview, outdated, atau kegagalan verifikasi.