الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

إنشاء رمز تطبيق GitHub

إجراء GitHub لإنشاء رمز وصول لتثبيت تطبيق GitHub.

الاستخدام

لاستخدام هذا الإجراء، تحتاج إلى:

  1. قم بتسجيل تطبيق GitHub الجديد
  2. قم بتخزين معرف التطبيق في متغيرات بيئة المستودع لديك (على سبيل المثال: APP_ID )
  3. قم بتخزين المفتاح الخاص للتطبيق في أسرار المستودع الخاص بك (على سبيل المثال: PRIVATE_KEY )

مهم

تنتهي صلاحية رمز وصول التثبيت بعد ساعة واحدة. يرجى الاطلاع على هذا التعليق لمعرفة الطرق البديلة إذا كانت لديك عمليات طويلة الأمد.

قم بإنشاء رمز مميز للمستودع الحالي 

 name : Run tests on staging
on :
  push :
    branches :
      - main

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - uses : ./actions/staging-tests
        with :
          token : ${{ steps.app-token.outputs.token }}

استخدم رمز التطبيق مع actions/checkout 

 on : [pull_request]

jobs :
  auto-format :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          # required
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - uses : actions/checkout@v4
        with :
          token : ${{ steps.app-token.outputs.token }}
          ref : ${{ github.head_ref }}
          # Make sure the value of GITHUB_TOKEN will not be persisted in repo's config
          persist-credentials : false
      - uses : creyD/[email protected]
        with :
          github_token : ${{ steps.app-token.outputs.token }}

قم بإنشاء سلسلة ملتزم git لتثبيت التطبيق 

 on : [pull_request]

jobs :
  auto-format :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          # required
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - name : Get GitHub App User ID
        id : get-user-id
        run : echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
        env :
          GH_TOKEN : ${{ steps.app-token.outputs.token }}
      - id : committer
        run : echo "string=${{ steps.app-token.outputs.app-slug }}[bot] <${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com>"  >> "$GITHUB_OUTPUT"
      - run : echo "committer string is ${ {steps.committer.outputs.string }}"

قم بتكوين git CLI لمستخدم الروبوت الخاص بالتطبيق 

 on : [pull_request]

jobs :
  auto-format :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          # required
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
      - name : Get GitHub App User ID
        id : get-user-id
        run : echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
        env :
          GH_TOKEN : ${{ steps.app-token.outputs.token }}
      - run : |
          git config --global user.name '${{ steps.app-token.outputs.app-slug }}[bot]'
          git config --global user.email '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com>'
      # git commands like commit work using the bot user
      - run : |
          git add .
          git commit -m "Auto-generated changes"
          git push

نصيحة

<BOT USER ID> هو معرف المستخدم الرقمي لمستخدم الروبوت الخاص بالتطبيق، والذي يمكن العثور عليه ضمن https://api.github.com/users/<app-slug>%5Bbot%5D .

على سبيل المثال، يمكننا التحقق من https://api.github.com/users/dependabot[bot] لمعرفة معرف المستخدم الخاص بـ Dependabot هو 49699333.

وبدلاً من ذلك، يمكنك استخدام octokit/request-action للحصول على المعرف.

قم بإنشاء رمز مميز لجميع المستودعات في تثبيت المالك الحالي 

 on : [workflow_dispatch]

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : ${{ github.repository_owner }}
      - uses : peter-evans/create-or-update-comment@v3
        with :
          token : ${{ steps.app-token.outputs.token }}
          issue-number : ${{ github.event.issue.number }}
          body : " Hello, World! "

قم بإنشاء رمز مميز لمستودعات متعددة في تثبيت المالك الحالي 

 on : [issues]

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : ${{ github.repository_owner }}
          repositories : |
            repo1
            repo2
      - uses : peter-evans/create-or-update-comment@v3
        with :
          token : ${{ steps.app-token.outputs.token }}
          issue-number : ${{ github.event.issue.number }}
          body : " Hello, World! "

قم بإنشاء رمز مميز لجميع المستودعات في تثبيت مالك آخر 

 on : [issues]

jobs :
  hello-world :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : another-owner
      - uses : peter-evans/create-or-update-comment@v3
        with :
          token : ${{ steps.app-token.outputs.token }}
          issue-number : ${{ github.event.issue.number }}
          body : " Hello, World! "

إنشاء الرموز المميزة لحسابات مستخدمين أو مؤسسات متعددة

يمكنك استخدام إستراتيجية المصفوفة لإنشاء الرموز المميزة لحسابات مستخدمين أو مؤسسات متعددة.

ملحوظة

راجع هذه الوثائق للحصول على معلومات حول استخدام السلاسل متعددة الأسطر في سير العمل. 

 on : [workflow_dispatch]

jobs :
  set-matrix :
    runs-on : ubuntu-latest
    outputs :
      matrix : ${{ steps.set.outputs.matrix }}
    steps :
      - id : set
        run : echo 'matrix=[{"owner":"owner1"},{"owner":"owner2","repos":["repo1"]}]' >>"$GITHUB_OUTPUT"

  use-matrix :
    name : " @${{ matrix.owners-and-repos.owner }} installation "
    needs : [set-matrix]
    runs-on : ubuntu-latest
    strategy :
      matrix :
        owners-and-repos : ${{ fromJson(needs.set-matrix.outputs.matrix) }}

    steps :
      - uses : actions/create-github-app-token@v1
        id : app-token
        with :
          app-id : ${{ vars.APP_ID }}
          private-key : ${{ secrets.PRIVATE_KEY }}
          owner : ${{ matrix.owners-and-repos.owner }}
          repositories : ${{ join(matrix.owners-and-repos.repos) }}
      - uses : octokit/[email protected]
        id : get-installation-repositories
        with :
          route : GET /installation/repositories
        env :
          GITHUB_TOKEN : ${{ steps.app-token.outputs.token }}
      - run : echo "$MULTILINE_JSON_STRING"
        env :
          MULTILINE_JSON_STRING : ${{ steps.get-installation-repositories.outputs.data }}

قم بتشغيل سير العمل في مستودع github.com مقابل مؤسسة في GitHub Enterprise Server 

 on : [push]

jobs :
  create_issue :
    runs-on : self-hosted

    steps :
    - name : Create GitHub App token
      id : create_token
      uses : actions/create-github-app-token@v1
      with :
        app-id : ${{ vars.GHES_APP_ID }}
        private-key : ${{ secrets.GHES_APP_PRIVATE_KEY }}
        owner : ${{ vars.GHES_INSTALLATION_ORG }}
        github-api-url : ${{ vars.GITHUB_API_URL }}

    - name : Create issue
      uses : octokit/[email protected]
      with :
        route : POST /repos/${{ github.repository }}/issues
        title : " New issue from workflow "
        body : " This is a new issue created from a GitHub Action workflow. "
      env :
        GITHUB_TOKEN : ${{ steps.create_token.outputs.token }}

المدخلات

app-id

مطلوب: معرف تطبيق GitHub.

private-key

مطلوب: المفتاح الخاص لتطبيق GitHub. سيتم استبدال الأسطر الجديدة التي تم تجاوزها ( \n ) تلقائيًا بأسطر جديدة فعلية.

قد تتطلب بعض الإجراءات الأخرى أن يكون المفتاح الخاص مشفرًا باستخدام Base64. لتجنب إعادة إنشاء سر جديد، يمكن فك تشفيره بسرعة، ولكن يجب إدارته بشكل آمن. وفيما يلي مثال لكيفية تحقيق ذلك: 

 steps :
  - name : Decode the GitHub App Private Key
    id : decode
    run : |
      private_key=$(echo "${{ secrets.PRIVATE_KEY }}" | base64 -d | awk 'BEGIN {ORS="\n"} {print}' | head -c -2) &> /dev/null
      echo "::add-mask::$private_key"
      echo "private-key=$private_key" >> "$GITHUB_OUTPUT"
  - name : Generate GitHub App Token
    id : app-token
    uses : actions/create-github-app-token@v1
    with :
      app-id : ${{ vars.APP_ID }}
      private-key : ${{ steps.decode.outputs.private-key }}

owner

اختياري: مالك تثبيت تطبيق GitHub. إذا كان فارغًا، فسيتم تعيينه افتراضيًا إلى مالك المستودع الحالي.

repositories

اختياري: قائمة المستودعات المفصولة بفواصل أو أسطر جديدة لمنح حق الوصول إليها.

ملحوظة

إذا تم تعيين owner وكانت repositories فارغة، فسيتم تحديد نطاق الوصول إلى جميع المستودعات في تثبيت مالك المستودع المقدم. إذا كان owner repositories فارغة، فسيتم تحديد نطاق الوصول إلى المستودع الحالي فقط.

skip-token-revoke

اختياري: إذا كان الرمز صحيحًا، فلن يتم إلغاء الرمز المميز عند اكتمال المهمة الحالية.

github-api-url

اختياري: عنوان URL لواجهة برمجة تطبيقات GitHub REST. يتم تعيينه افتراضيًا على عنوان URL الخاص بـ GitHub Rest API حيث يتم تشغيل سير العمل منه.

النواتج

token

رمز الوصول لتثبيت تطبيق GitHub.

installation-id

معرف تثبيت تطبيق GitHub.

app-slug

سبيكة تطبيق GitHub.

كيف يعمل

ينشئ الإجراء رمز وصول للتثبيت باستخدام نقطة نهاية POST /app/installations/{installation_id}/access_tokens . بشكل افتراضي،

  1. يتم تحديد نطاق الرمز المميز إلى المستودع الحالي أو repositories إذا تم تعيينه.
  2. يرث الرمز المميز كافة أذونات التثبيت.
  3. يتم تعيين الرمز المميز token إخراج يمكن استخدامه في الخطوات اللاحقة.
  4. ما لم يتم تعيين skip-token-revoke على قيمة صحيحة، فسيتم إبطال الرمز المميز في خطوة post الإجراء، مما يعني أنه لا يمكن تمريره إلى مهمة أخرى.
  5. الرمز المميز مقنع، ولا يمكن تسجيله عن طريق الخطأ.

ملحوظة

يمكن أن تختلف أذونات التثبيت عن أذونات التطبيق التي تنتمي إليها. يتم تعيين أذونات التثبيت عند تثبيت التطبيق على الحساب. عندما يضيف التطبيق المزيد من الأذونات بعد التثبيت، سيتعين على مسؤول الحساب الموافقة على الأذونات الجديدة قبل تعيينها على التثبيت.

رخصة

معهد ماساتشوستس للتكنولوجيا

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل