Panduan: Menjalankan Aliran Kerja Git pada Pelari yang Sama

Lucas Simon

Ahad, 19 Mei 2024 8:25:16 PTG

Menyelaras Aliran Kerja GitHub pada Pelari Dikongsi
Menguruskan berbilang aliran kerja dalam Tindakan GitHub boleh menjadi mencabar, terutamanya apabila anda memerlukannya untuk dijalankan pada pelari yang dihoskan sendiri yang sama. Dalam senario di mana anda mempunyai fail YAML yang berasingan untuk aliran kerja yang berbeza, seperti codeql.yml dan snyk-zap.yml, memastikan ia dijalankan pada pelari yang sama daripada kumpulan tertentu boleh menjadi rumit.
Matlamatnya adalah untuk menggunakan pelari yang sama untuk kedua-dua aliran kerja tanpa menamakan pelari secara eksplisit, dengan itu mengelakkan konflik dengan aliran kerja lain. Panduan ini akan meneroka penyelesaian yang mungkin untuk mencapai penyegerakan ini dengan cekap sambil mengekalkan aliran kerja dalam fail YAML yang berasingan.

Perintah Penerangan

jq Pemproses JSON baris perintah yang ringan dan fleksibel digunakan untuk menghuraikan output JSON dalam skrip Bash.

head -n 1 Mengeluarkan baris pertama keputusan, digunakan di sini untuk memilih ID pelari pertama yang tersedia.

curl Alat baris perintah untuk memindahkan data dengan URL, digunakan untuk berinteraksi dengan API GitHub dalam skrip Bash.

os.getenv() Mendapatkan semula pembolehubah persekitaran dalam Python, digunakan untuk mendapatkan token GitHub dan nama repositori.

requests.get() Menghantar permintaan GET ke URL yang ditentukan, digunakan untuk mengambil pelari yang tersedia daripada API GitHub dalam skrip Python.

os.path.exists() Menyemak sama ada laluan tertentu wujud, digunakan untuk menentukan sama ada fail ID runner sudah ada dalam skrip Python.

with open() Pengurus konteks untuk operasi fail dalam Python, digunakan untuk membaca dan menulis ID pelari pada fail.

Perintah	Penerangan
jq	Pemproses JSON baris perintah yang ringan dan fleksibel digunakan untuk menghuraikan output JSON dalam skrip Bash.
head -n 1	Mengeluarkan baris pertama keputusan, digunakan di sini untuk memilih ID pelari pertama yang tersedia.
curl	Alat baris perintah untuk memindahkan data dengan URL, digunakan untuk berinteraksi dengan API GitHub dalam skrip Bash.
os.getenv()	Mendapatkan semula pembolehubah persekitaran dalam Python, digunakan untuk mendapatkan token GitHub dan nama repositori.
requests.get()	Menghantar permintaan GET ke URL yang ditentukan, digunakan untuk mengambil pelari yang tersedia daripada API GitHub dalam skrip Python.
os.path.exists()	Menyemak sama ada laluan tertentu wujud, digunakan untuk menentukan sama ada fail ID runner sudah ada dalam skrip Python.
with open()	Pengurus konteks untuk operasi fail dalam Python, digunakan untuk membaca dan menulis ID pelari pada fail.

Menyelaraskan Aliran Kerja dengan Pelari Dikongsi

Skrip yang disediakan mengurus tugasan pelari untuk aliran kerja GitHub. Skrip Bash bermula dengan menyemak sama ada ID pelari telah disimpan dalam fail sementara. Jika tidak, ia menggunakan untuk menanyakan API GitHub untuk pelari yang tersedia dan untuk menghuraikan respons JSON, memilih pelari terbiar pertama dan menyimpan IDnya. Skrip Python mencapai fungsi yang sama dengan menggunakan kaedah untuk mengambil maklumat pelari daripada API GitHub. Skrip kemudian menyemak sama ada ID pelari telah disimpan menggunakan os.path.exists() dan menyimpannya jika tidak.

Kedua-dua skrip memastikan bahawa sebaik sahaja pelari ditugaskan, ia akan digunakan semula untuk kerja seterusnya dengan merujuk ID pelari yang disimpan. Dalam skrip Python, mendapatkan semula pembolehubah persekitaran untuk token dan repositori GitHub, dan digunakan untuk mengendalikan operasi fail dengan selamat. Skrip ini membantu menyelaraskan berbilang aliran kerja, memastikan ia berjalan pada pelari yang sama tanpa pengekodan keras nama pelari, menjadikannya fleksibel dan cekap dalam mengurus pelaksanaan aliran kerja.

Melaksanakan Strategi Pelari Dikongsi untuk Tindakan GitHub

Menggunakan skrip Bash dan Tindakan GitHub untuk memastikan aliran kerja berjalan pada pelari yang sama

# A script to manage runner assignment
#!/bin/bash

# Check if a runner is already assigned
RUNNER_ID=$(cat /tmp/runner_id)

if [ -z "$RUNNER_ID" ]; then
  # No runner assigned yet, pick one and save its ID
  RUNNER_ID=$(curl -s -H "Authorization: token $GITHUB_TOKEN" \
               https://api.github.com/repos/$GITHUB_REPOSITORY/actions/runners |
               jq -r '.runners[] | select(.status=="online" and .busy==false) | .id' | head -n 1)
  echo $RUNNER_ID > /tmp/runner_id
fi

echo "Using runner $RUNNER_ID"

# Proceed with the workflow using the assigned runner

Memastikan Penggunaan Pelari yang Konsisten dalam Fail YAML Berasingan

Menggunakan Tindakan Python dan GitHub untuk pelaksanaan aliran kerja yang diselaraskan

import requests
import os

# GitHub API token and repository
GITHUB_TOKEN = os.getenv('GITHUB_TOKEN')
REPO = os.getenv('GITHUB_REPOSITORY')

# Function to get an available runner
def get_runner():
    url = f"https://api.github.com/repos/{REPO}/actions/runners"
    headers = {'Authorization': f'token {GITHUB_TOKEN}'}
    response = requests.get(url, headers=headers)
    runners = response.json()['runners']
    for runner in runners:
        if runner['status'] == 'online' and not runner['busy']:
            return runner['id']
    return None

# Check if a runner is already assigned
if not os.path.exists('/tmp/runner_id'):
    runner_id = get_runner()
    with open('/tmp/runner_id', 'w') as f:
        f.write(str(runner_id))
else:
    with open('/tmp/runner_id', 'r') as f:
        runner_id = f.read()

print(f"Using runner {runner_id}")

Pengurusan Pelari yang Cekap dalam Tindakan GitHub

Dalam senario di mana aliran kerja perlu dijalankan pada pelari yang dihoskan sendiri yang sama, pertimbangan utama ialah memastikan ketersediaan pelari dan meminimumkan konflik. Menggunakan strategi pelari yang dikongsi, seperti yang dilihat dalam skrip sebelumnya, memastikan bahawa sebaik sahaja pelari ditugaskan untuk pekerjaan, pekerjaan seterusnya menggunakan pelari yang sama. Ini boleh memberi manfaat terutamanya dalam saluran paip CI/CD yang kompleks di mana mengekalkan keadaan atau menggunakan sumber cache adalah penting.

Satu lagi aspek yang perlu dipertimbangkan ialah mengoptimumkan penggunaan pelari. Dengan memilih dan menetapkan pelari secara dinamik berdasarkan ketersediaan, organisasi boleh mengurus sumber mereka dengan lebih baik. Melaksanakan strategi sedemikian bukan sahaja meningkatkan kecekapan tetapi juga mengurangkan masa yang dihabiskan oleh aliran kerja dalam baris gilir, menunggu pelari yang tersedia. Pendekatan ini boleh diperluaskan kepada alat dan platform CI/CD lain, menjadikannya penyelesaian serba boleh untuk pelbagai keperluan automasi.

Bagaimanakah saya memastikan pelari tertentu sentiasa digunakan?
Menggunakan masukkan fail YAML anda untuk menentukan kumpulan pelari atau nama pelari yang tepat.
Bolehkah saya menetapkan pelari secara dinamik kepada aliran kerja?
Ya, dengan menggunakan skrip untuk menanyakan pelari yang tersedia dan memberikannya secara dinamik.
Bagaimanakah saya mengendalikan konflik pelari dalam persekitaran yang sibuk?
Laksanakan mekanisme beratur atau utamakan aliran kerja untuk mengurus peruntukan pelari dengan berkesan.
Apa yang berlaku jika tiada pelari tersedia?
Aliran kerja akan beratur sehingga seorang pelari tersedia. Optimumkan penggunaan pelari untuk meminimumkan masa menunggu.
Bolehkah saya menggunakan skrip ini dengan platform CI/CD lain?
Ya, logik boleh disesuaikan untuk platform lain dengan akses API kepada pengurusan pelari.
Bagaimanakah saya mengekalkan keadaan antara aliran kerja?
Pastikan pelari yang sama digunakan untuk pekerjaan yang berkaitan dan memanfaatkan mekanisme caching jika boleh.
Apakah kebenaran yang diperlukan untuk skrip ini?
Pastikan token GitHub anda mempunyai skop yang diperlukan, seperti dan .
Bolehkah saya menjalankan berbilang aliran kerja serentak pada pelari yang sama?
Biasanya, tidak. Setiap pelari melaksanakan satu kerja pada satu masa. Gunakan berbilang pelari untuk konkurensi.
Bagaimanakah saya memantau penggunaan dan prestasi pelari?
Gunakan alat pemantauan terbina dalam GitHub atau perkhidmatan luaran untuk menjejak aktiviti dan prestasi pelari.

Kesimpulan:

Menguruskan aliran kerja GitHub untuk dijalankan pada pelari yang dihoskan sendiri yang sama adalah penting untuk kecekapan dan konsistensi. Skrip Bash dan Python yang dibincangkan menyediakan penyelesaian yang mantap dengan menetapkan pelari secara dinamik dan memastikan pekerjaan berikutnya menggunakan pelari yang sama. Pendekatan ini meminimumkan konflik dan mengoptimumkan penggunaan sumber, menjadikannya strategi yang berkesan untuk saluran paip CI/CD yang kompleks. Dengan melaksanakan kaedah ini, organisasi boleh menyelaraskan pelaksanaan aliran kerja mereka dan mengurangkan masa menunggu, akhirnya meningkatkan produktiviti dan mengekalkan proses pembangunan yang lancar.