setup-gcloud
جيثبيقوم بتكوين Google Cloud SDK في بيئة GitHub Actions. تتضمن Google Cloud SDK كلا من الثنائيات gcloud وgsutil.
أو قم بالتكامل أصلاً مع إجراءات Google Cloud GitHub الأخرى:
هذا ليس أحد منتجات Google المدعومة رسميًا، ولا يغطيه عقد دعم Google Cloud. للإبلاغ عن الأخطاء أو طلب الميزات في منتج Google Cloud، يرجى الاتصال بدعم Google Cloud.
يتطلب هذا الإجراء بيانات اعتماد Google Cloud لتنفيذ أوامر gcloud. راجع التفويض لمزيد من التفاصيل.
يتم تشغيل هذا الإجراء باستخدام Node 20. إذا كنت تستخدم مشغلات GitHub Actions ذاتية الاستضافة، فيجب عليك استخدام إصدار مشغل يدعم هذا الإصدار أو إصدار أحدث.
jobs :
job_id :
# Add "id-token" with the intended permissions.
permissions :
contents : ' read '
id-token : ' write '
steps :
- id : ' auth '
uses : ' google-github-actions/auth@v2 '
with :
workload_identity_provider : ' projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider '
service_account : ' [email protected] '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
with :
version : ' >= 363.0.0 '
- name : ' Use gcloud CLI '
run : ' gcloud info '
version
: (اختياري، افتراضي: latest
) سلسلة تمثل الإصدار أو قيد الإصدار من Cloud SDK ( gcloud
) المطلوب تثبيته (على سبيل المثال "290.0.1"
أو ">= 197.0.1"
). القيمة الافتراضية هي "latest"
، والتي ستقوم دائمًا بتنزيل وتثبيت أحدث إصدار متوفر من Cloud SDK.
- uses: 'google-github-actions/setup-gcloud@v2'
with:
version: '>= 416.0.0'
إذا لم يكن هناك إصدار gcloud
مثبت يطابق القيد المحدد، فسيقوم إجراء GitHub هذا بتنزيل وتثبيت أحدث إصدار متاح لا يزال يطابق القيد.
تتطلب المصادقة عبر Workload Identity Union الإصدار 363.0.0 أو أحدث. إذا كنت بحاجة إلى دعم لـ Workload Identity Union، فحدد قيد الإصدار الخاص بك على هذا النحو:
- uses: 'google-github-actions/setup-gcloud@v2'
with:
version: '>= 363.0.0'
أنت مسؤول عن ضمان تطابق إصدار gcloud
مع الميزات والمكونات المطلوبة.
project_id
: (اختياري) معرف مشروع Google Cloud. إذا تم توفيره، فسيؤدي ذلك إلى تكوين gcloud لاستخدام معرف المشروع هذا افتراضيًا للأوامر. لا يزال بإمكان الأوامر الفردية تجاوز المشروع باستخدام علامة --project
التي لها الأولوية. إذا لم يتم تحديده، فسيحاول الإجراء العثور على معرف المشروع "الأفضل" من خلال النظر في المدخلات الأخرى ومتغيرات البيئة.
install_components
: (اختياري) قائمة بمكونات gcloud الإضافية المراد تثبيتها، المحددة كقائمة سلاسل مفصولة بفواصل:
install_components: 'alpha,cloud-datastore-emulator'
skip_install
: (اختياري) تخطي تثبيت gcloud واستخدم الإصدار الذي يوفره النظام بدلاً من ذلك. إذا تم تحديده، فسيتم تجاهل إدخال version
.
version
: إصدار gcloud الذي تم تثبيته. يقوم الإجراء setup-gcloud
بتثبيت Cloud SDK ( gcloud
). لتكوين المصادقة على Google Cloud، يجب عليك أولاً استخدام الإجراء google-github-actions/auth. يقوم إجراء auth
بتعيين بيانات اعتماد التطبيق الافتراضية، ثم يشير إجراء setup-gcloud
إلى بيانات الاعتماد هذه لتكوين بيانات اعتماد gcloud. يمكنك المصادقة عبر الخيارات التالية:
bq
و gsutil
.
jobs :
job_id :
# Add "id-token" with the intended permissions.
permissions :
contents : ' read '
id-token : ' write '
steps :
- id : ' auth '
uses : ' google-github-actions/auth@v2 '
with :
workload_identity_provider : ' projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider '
service_account : ' [email protected] '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud info '
jobs :
job_id :
steps :
- id : ' auth '
uses : ' google-github-actions/auth@v2 '
with :
credentials_json : ' ${{ secrets.GCP_CREDENTIALS }} '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud info '
إذا كنت تستخدم مشغلات مستضافة ذاتيًا تتم استضافتها على Google Cloud Platform، فسيتم الحصول على بيانات الاعتماد تلقائيًا من حساب الخدمة المرتبط بالمشغل. في هذا السيناريو، لا تحتاج إلى تشغيل الإجراء google-github-actions/auth.
jobs :
job_id :
steps :
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud info '
لاستخدام حسابات خدمة متعددة، يلزم اتخاذ خطوة مصادقة ثانية لتحديث بيانات الاعتماد قبل استخدام setup-gcloud
:
jobs :
job_id :
# Add "id-token" with the intended permissions.
permissions :
contents : ' read '
id-token : ' write '
steps :
- id : ' auth service account 1 '
uses : ' google-github-actions/auth@v2 '
with :
workload_identity_provider : ' projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider '
service_account : ' [email protected] '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud auth list --filter=status:ACTIVE --format="value(account)" '
# [email protected]
- id : ' auth service account 2 '
uses : ' google-github-actions/auth@v2 '
with :
credentials_json : ' ${{ secrets.GCP_CREDENTIALS }} '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud auth list --filter=status:ACTIVE --format="value(account)" '
# [email protected]
نوصي بالتثبيت على أحدث إصدار رئيسي متاح:
- uses : ' google-github-actions/setup-gcloud@v2 '
بينما يحاول هذا الإجراء اتباع الإصدارات الدلالية، إلا أننا في النهاية بشر ونرتكب الأخطاء أحيانًا. لمنع حدوث تغييرات غير مقصودة، يمكنك أيضًا تثبيت إصدار محدد:
- uses : ' google-github-actions/[email protected] '
ومع ذلك، لن تحصل على تحديثات أمنية تلقائية أو ميزات جديدة دون تحديث رقم الإصدار الخاص بك بشكل صريح. لاحظ أننا ننشر فقط إصدارات MAJOR
و MAJOR.MINOR.PATCH
. لا يوجد اسم مستعار عائم لـ MAJOR.MINOR
.