TirSystem/github-action
0
1
Fork 0
Code Issues 5 Pull Requests 1 Actions Packages Projects Releases 3 Wiki Activity
Files
mil-007-cpp-csharp-workflows
github-action/wiki/Onboarding.ms.md
T
Tirsvad de2e28e637
Validate workflows / validate (pull_request) Successful in 16s
Details
Document how a repository opts in to wiki publishing 
Describe the wiki/.publish marker and the prune word, the per-organisation
TOKEN_FOR_GITEA_WIKI without fallback, and the new messages in the
onboarding, credentials and troubleshooting guides and the README. Add the
capability row and regenerate the five English wiki pages with their Danish
and Bahasa Malaysia translations.

Task: MIL-006#5
2026-10-10 11:54:54 +08:00

5.5 KiB
Raw Permalink Blame History

Ini ialah terjemahan Onboarding. Halaman bahasa Inggeris ialah teks yang sah, dan perubahan di sini akan ditimpa pada penerbitan wiki yang seterusnya.

English | Dansk | Bahasa Melayu

Menyertakan sebuah repositori

Cara seorang profesional DevOps menjadikan repositori TirSystem menggunakan aliran kerja bersama Sync GitHub mirror metadata, dan runner yang diperlukannya. Hanya aliran kerja ini yang wujud sekarang; aliran kerja semakan kualiti dan keluaran dirancang (lihat Pelan Projek).

Perkara yang telah disahkan

Perkara Status
Versi Gitea 1.27.3
.gitea/scoped_workflows/sync-github-metadata.yml berjalan dalam repositori ini Disahkan: larian 16, workflow_dispatch, berjaya
Aliran kerja yang sama terpakai pada repositori lain secara automatik Disahkan pada 2026-10-10: ia berjalan, tanpa salinan dalam repositori, dalam repositori TirSystem, TirSystem-BashScript, vl-staal dan Tirsvad-Udemy-100-days-of-code (contohnya TirSystem/sqa-qc-checklists dan TirSystem-BashScript/RepoFoundry). Skrip yang dijalankannya berubah apabila skrip repositori ini berubah.

Penghantaran adalah automatik, jadi repositori tidak memerlukan salinan aliran kerja. Rahsia (secret) tidak dikongsi antara organisasi: setiap organisasi memerlukan rahsianya sendiri (langkah 3).

Langkah

  1. Semak prasyarat dalam repositori: Actions diaktifkan, dan runner dengan label ubuntu-latest dan python3 berada dalam talian (lihat Runners).
  2. Konfigurasikan satu push mirror GitHub dalam tetapan repositori (Settings, Repository, Mirror settings, Push mirror). Aliran kerja gagal jika terdapat beberapa cermin GitHub. Jika tiada, ia berjaya tanpa menyegerakkan apa-apa.
  3. Tambah dua rahsia (secret) dalam tetapan repositori (atau organisasi), dengan skop yang tertera dalam credentials.md. Aliran kerja berjalan dalam setiap repositori sesebuah organisasi, jadi simpan rahsia sekali bagi setiap organisasi; repositori dalam organisasi lain tidak melihatnya:
    • TOKEN_FOR_GITEA
    • PAT_FOR_GITHUB (token GitHub sahaja)
  4. Hantar aliran kerja: scoped workflow terpakai pada setiap repositori dalam instans ini, jadi tiada apa yang perlu disalin. Hanya jika penghantaran scoped tidak disediakan, salin .gitea/scoped_workflows/sync-github-metadata.yml dari repositori ini ke .gitea/workflows/ dalam repositori sasaran, sematkan salinan itu pada versi yang telah disemak dan salin semula apabila ia berubah.
  5. Tetapkan penerangan dan topik pada repositori Gitea, supaya ada sesuatu untuk disegerakkan.
  6. Jalankan sekali secara manual: Actions, Sync GitHub mirror metadata, Run workflow. Log mesti berakhir dengan Synced description and topics to <owner>/<repo>. dan repositori GitHub mesti menunjukkan penerangan dan topik yang sama.
  7. Jika gagal, gunakan troubleshooting.md.

Menerbitkan wiki (pilihan)

Aliran kerja Publish wiki menyalin halaman Markdown dalam wiki/ ke wiki repositori apabila perubahan pada wiki/ digabungkan ke main. Ia dihantar seperti aliran kerja penyegerakan, tetapi hanya menulis di tempat repositori telah memilih untuk menyertainya.

  1. Aktifkan wiki dalam tetapan repositori.
  2. Tambah halaman Markdown ke wiki/. Nama fail ialah nama halaman: Home.md ialah halaman utama.
  3. Tambah penanda wiki/.publish. Biarkan kosong untuk mencipta dan mengemas kini halaman sahaja. Letakkan satu perkataan prune di dalamnya untuk turut memadam halaman wiki yang tiada dalam wiki/, supaya wiki sentiasa sama dengan folder itu.
  4. Simpan TOKEN_FOR_GITEA_WIKI sebagai secret organisasi repositori, dengan skop yang tertera dalam credentials.md.
  5. Gabungkan perubahan ke main. Log mesti berakhir dengan Published <n> page(s) to the wiki of <owner>/<repo>.

Repositori tanpa wiki/.publish dilangkau dengan baris No wiki/.publish marker in <owner>/<repo>: tiada apa-apa ditulis dan tiada secret diperlukan.

Runners

Perkara Nilai
Label yang digunakan oleh aliran kerja ubuntu-latest
Label yang ditawarkan oleh runner pada instans ini ubuntu-latest, ubuntu-24.04, ubuntu-22.04
Alat yang diperlukan oleh aliran kerja python3 (pustaka standard sahaja), HTTPS keluar ke API Gitea dan api.github.com
Diperlukan untuk actions/checkout (digunakan oleh aliran kerja pengesahan) git dan Node.js, biasanya terdapat dalam imej runner

Semak bahawa runner yang sesuai berada dalam talian (memerlukan kebenaran untuk melihat runner):

curl -s -H "Authorization: token $GITEA_TOKEN" \
  https://git.tirsystem.com/api/v1/repos/<owner>/<repo>/actions/runners

Bagi runner yang dikongsi oleh seluruh instans, pentadbir menggunakan /api/v1/admin/actions/runners. Pada masa penulisan, senarai repositori dan organisasi kosong dan satu runner peringkat instans (36cd20104923) berstatus online.

Runner luar talian atau tidak serasi

Gejala Punca yang mungkin Tindakan
Larian kekal waiting Tiada runner dalam talian yang mempunyai label dalam runs-on Mulakan runner, atau daftarkan satu dengan label itu
Kerja gagal pada permulaan dengan arahan yang tiada Imej runner tiada python3, git atau Node.js Gunakan imej yang mempunyainya
Kerja tidak dapat mencapai API Runner tiada HTTPS keluar Betulkan tetapan rangkaian atau proksi runner
Reference in New Issue View Git Blame Copy Permalink