ghpages

Tindakan GitHub untuk Menyebarkan Aset Statis ke Halaman GitHub

Tindakan ini sudah tidak digunakan lagi. Kini ada dukungan "asli" untuk penerbitan ke Halaman GitHub menggunakan tindakan GitHub resmi dari GitHub. Ini jauh lebih baik daripada pendekatan ini.

Tindakan ini memungkinkan Anda menyebarkan folder konten statis sewenang-wenang dari direktori kerja alur kerja Anda ( /github/workspace ) ke halaman GitHub. Ini bekerja dengan membuat instance tindakan Anda git push folder aset pilihan Anda ( BUILD_DIR ) ke cabang gh-pages dari repositori GitHub Anda agar cabang gh-pages dapat dilayani. Jika Anda menjalankan tindakan ini di dalam organisasi atau repositori pengguna (bernama username/username.github.io ), tindakan ini akan diterapkan ke cabang master .

Ingatlah bahwa Anda mungkin juga harus menyesuaikan pengaturan repositori Anda.

Karena tindakan ini diterapkan ke cabang "deploy-only" yang terpisah, Anda tidak dapat menggunakannya jika ingin menerapkan dari subdirektori repo seperti docs/ . Dalam kasus tersebut, Anda benar-benar tidak memerlukan Tindakan GitHub, karena Anda sendiri yang akan melakukan artefak build. Untuk detailnya lihat Dokumentasi Halaman GitHub.

Sudah ada tindakan GitHub yang bagus untuk menggunakan generator situs statis dan kemudian menyebarkannya ke Halaman GitHub (untuk jekyll, jekyll, zola, dan tentunya masih banyak lagi yang akan datang). Tindakan ini bukan itu, meskipun saya telah meminjam banyak tindakan git dari karya-karya ini.

Tindakan ini tidak akan menghasilkan apa pun, melainkan hanya menyebarkan.

Masukan

Tidak ada.

Keluaran

Tidak ada.

Rahasia

Penerapan ke halaman GitHub dilakukan dengan git push ke cabang gh-pages (atau master ). Untuk mengotorisasi ini, tindakan GitHub memerlukan sebuah rahasia. Untuk saat ini, agak membingungkan, GITHUB_TOKEN yang tersedia untuk setiap repo cukup untuk mendorong ke gh-pages , namun tidak cukup untuk memicu pembuatan halaman di GitHub, atau bahkan menyebarkan konten ke jaringan pengiriman konten GitHub.

Oleh karena itu, Anda harus membuat Personal Access Token (PAT) khusus seperti yang Anda lakukan untuk layanan eksternal (misalnya, Travis). Token ini harus dibuat dengan izin repo untuk diterapkan ke Halaman Github. Anda kemudian harus menempelkan token ini ke UI GitHub sebagai rahasia dengan nama GH_PAT (pengaturan/rahasia repositori) dan memanggilnya dalam tindakan seperti di bawah ini.

Saya telah meminta GitHub untuk menyederhanakan proses ini. Diskusi tersebut didokumentasikan di sini.

Variabel Lingkungan

Hanya BUILD_DIR , direktori build yang berhubungan dengan root repositori Anda. Anda juga bisa lulus . jika Anda ingin mendorong root repositori Anda.

Contoh Penggunaan

 name : Deployment

" on " :
  - push
  - pull_request

jobs :
  deploy_ghpages :
    runs-on : ubuntu-18.04
    steps :
      - uses : actions/checkout@v1
      - run : echo $GITHUB_SHA >> public/index.html
      - uses : maxheld83/[email protected]
        env :
          BUILD_DIR : public/
          GH_PAT : ${{ secrets.GH_PAT }}