Panduan DCC HRIS

Versi dan rilis

Satu nomor versi untuk app staff, app admin, dan panduan ini, ditandai dengan tag git dan GitHub Release.

Satu versi untuk semuanya

App staff, app admin, dan panduan ini selalu memakai nomor versi yang sama. Panduan versi tertentu menjelaskan aplikasi dengan versi itu.

  • Nomor versi tertulis di version pada apps/staff/package.json dan apps/admin/package.json. Build panduan gagal jika keduanya berbeda.
  • Setiap rilis ditandai tag git v<versi> di main, misalnya v0.1.0.
  • GitHub Release untuk tag itu melampirkan panduan siap pakai, hr-manual-v<versi>.zip.
  • Footer setiap halaman panduan menampilkan versi dan hasil git describe, misalnya 0.1.0 (v0.1.0). Jika tertulis -dirty atau ada akhiran commit, panduan itu tidak dibuat tepat dari tag rilis.

Format versi mengikuti Semantic Versioning: MAJOR.MINOR.PATCH. Selama versi masih 0.x, naikkan MINOR untuk fitur baru dan PATCH untuk perbaikan.

Langkah rilis

  1. Pastikan main sudah berisi semua perubahan dan server dev sudah men-deploy-nya.

  2. Buat branch, naikkan version di apps/staff/package.json dan apps/admin/package.json, lalu perbarui halaman panduan untuk fitur yang berubah. Gabungkan lewat PR.

  3. Di main terbaru, buat ulang screenshot dan panduan (lihat Memperbarui panduan), lalu buat zip:

    make manual-zip
    
  4. Buat tag dan GitHub Release dengan zip itu:

    git tag -a v0.1.0 -m "v0.1.0"
    git push origin v0.1.0
    gh release create v0.1.0 docs/manual/hr-manual-v0.1.0.zip --title "v0.1.0" --notes "..."
    
  5. Tulis ringkasan perubahan di catatan rilis dalam bahasa Indonesia.

Panduan di server dev

Panduan versi terbaru terbuka untuk publik di docs.dev.dcc-system.com. Setiap kali GitHub Release dipublikasikan, workflow .github/workflows/deploy-docs.yml mengambil hr-manual-v<versi>.zip dari Release itu dan memasangnya di server dev. Jadi langkah 4 di atas sekaligus men-deploy panduannya.

  • Release harus sudah berisi zip saat dipublikasikan. gh release create dengan lampiran sudah memenuhi syarat ini.
  • Jika workflow gagal, atau panduan versi lain perlu ditampilkan, jalankan workflow Deploy user manual to dev server dari tab Actions di GitHub dan isi tag-nya.
  • Server menyimpan panduan yang sedang tampil dan satu panduan sebelumnya. Cara kembali ke panduan sebelumnya ada di docs/dev-server.md.

Catatan Server dev sendiri selalu menjalankan main terbaru, sedangkan panduan di server mengikuti rilis terakhir. Di antara dua rilis, aplikasi di server dev bisa berisi fitur yang belum ada di panduan.

Panduan DCC HRIS · Versi 0.1.0 (v0.1.0) · dibuat 11 November 2026