New translation batch for cn (#23340)
* Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/lint-translation-files.js --check parsing * Run script/i18n/lint-translation-files.js --check rendering * run script/i18n/reset-known-broken-translation-files.js * Check in cn CSV report Co-authored-by: Francis <15894826+francisfuzz@users.noreply.github.com>
This commit is contained in:
docubot
@@ -1,20 +1,21 @@
|
||||
file,reason
|
||||
translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md,broken liquid tags
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md,broken liquid tags
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md,broken liquid tags
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md,broken liquid tags
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md,rendering error
|
||||
translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md,rendering error
|
||||
translations/zh-CN/content/actions/advanced-guides/caching-dependencies-to-speed-up-workflows.md,rendering error
|
||||
translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,broken liquid tags
|
||||
translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md,broken liquid tags
|
||||
translations/zh-CN/content/actions/advanced-guides/storing-workflow-data-as-artifacts.md,rendering error
|
||||
translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md,rendering error
|
||||
translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md,rendering error
|
||||
translations/zh-CN/content/actions/automating-builds-and-tests/building-and-testing-python.md,rendering error
|
||||
translations/zh-CN/content/actions/creating-actions/creating-a-javascript-action.md,rendering error
|
||||
translations/zh-CN/content/actions/creating-actions/metadata-syntax-for-github-actions.md,rendering error
|
||||
translations/zh-CN/content/actions/deployment/about-deployments/index.md,rendering error
|
||||
translations/zh-CN/content/actions/deployment/deploying-to-your-cloud-provider/index.md,rendering error
|
||||
translations/zh-CN/content/actions/deployment/managing-your-deployments/index.md,rendering error
|
||||
@@ -29,62 +30,64 @@ translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-r
|
||||
translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md,rendering error
|
||||
translations/zh-CN/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md,rendering error
|
||||
translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md,broken liquid tags
|
||||
translations/zh-CN/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md,rendering error
|
||||
translations/zh-CN/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/contexts.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/environment-variables.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/expressions.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/reusing-workflows.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and-administration.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/workflow-commands-for-github-actions.md,rendering error
|
||||
translations/zh-CN/content/actions/learn-github-actions/workflow-syntax-for-github-actions.md,rendering error
|
||||
translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md,broken liquid tags
|
||||
translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md,rendering error
|
||||
translations/zh-CN/content/actions/managing-workflow-runs/reviewing-deployments.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/actions/managing-workflow-runs/reviewing-deployments.md,rendering error
|
||||
translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md,broken liquid tags
|
||||
translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,broken liquid tags
|
||||
translations/zh-CN/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md,rendering error
|
||||
translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,rendering error
|
||||
translations/zh-CN/content/admin/advanced-security/configuring-code-scanning-for-your-appliance.md,rendering error
|
||||
translations/zh-CN/content/admin/advanced-security/configuring-secret-scanning-for-your-appliance.md,rendering error
|
||||
translations/zh-CN/content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/allowing-built-in-authentication-for-users-outside-your-identity-provider.md,rendering error
|
||||
translations/zh-CN/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-saml.md,rendering error
|
||||
translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-user-provisioning-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/authentication/managing-identity-and-access-for-your-enterprise/index.md,rendering error
|
||||
translations/zh-CN/content/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-network-settings/network-ports.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/accessing-the-management-console.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-custom-footers.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/index.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-for-mobile-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom.md,rendering error
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/configuration/managing-connections-between-your-enterprise-accounts/index.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/enterprise-support/overview/about-github-enterprise-support.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise-server.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/providing-data-to-github-support.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/reaching-github-support.md,rendering error
|
||||
translations/zh-CN/content/admin/enterprise-support/receiving-help-from-github-support/submitting-a-ticket.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/index.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-gateway-for-nas-storage.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/index.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae.md,rendering error
|
||||
@@ -96,71 +99,70 @@ translations/zh-CN/content/admin/github-actions/getting-started-with-github-acti
|
||||
translations/zh-CN/content/admin/github-actions/index.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md,rendering error
|
||||
translations/zh-CN/content/admin/github-actions/using-github-actions-in-github-ae/index.md,rendering error
|
||||
translations/zh-CN/content/admin/guides.md,rendering error
|
||||
translations/zh-CN/content/admin/index.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/index.md,rendering error
|
||||
translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md,rendering error
|
||||
translations/zh-CN/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md,rendering error
|
||||
translations/zh-CN/content/admin/overview/about-enterprise-accounts.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/admin/overview/about-enterprise-accounts.md,rendering error
|
||||
translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/packages/enabling-github-packages-with-aws.md,rendering error
|
||||
translations/zh-CN/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md,rendering error
|
||||
translations/zh-CN/content/admin/packages/enabling-github-packages-with-minio.md,rendering error
|
||||
translations/zh-CN/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md,rendering error
|
||||
translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md,broken liquid tags
|
||||
translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md,broken liquid tags
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,broken liquid tags
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md,broken liquid tags
|
||||
translations/zh-CN/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md,rendering error
|
||||
translations/zh-CN/content/admin/user-management/managing-organizations-in-your-enterprise/creating-teams.md,rendering error
|
||||
translations/zh-CN/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md,rendering error
|
||||
translations/zh-CN/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md,rendering error
|
||||
translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md,rendering error
|
||||
translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md,rendering error
|
||||
translations/zh-CN/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md,rendering error
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,rendering error
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md,rendering error
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md,rendering error
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md,rendering error
|
||||
translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md,rendering error
|
||||
translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,broken liquid tags
|
||||
translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,rendering error
|
||||
translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md,rendering error
|
||||
translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md,rendering error
|
||||
translations/zh-CN/content/billing/index.md,rendering error
|
||||
translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md,broken liquid tags
|
||||
translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md,broken liquid tags
|
||||
translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md,rendering error
|
||||
translations/zh-CN/content/billing/managing-billing-for-your-github-account/discounted-subscriptions-for-github-accounts.md,rendering error
|
||||
translations/zh-CN/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,parsing error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/getting-started/github-security-features.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/getting-started/securing-your-organization.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,rendering error
|
||||
translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md,rendering error
|
||||
translations/zh-CN/content/code-security/getting-started/github-security-features.md,rendering error
|
||||
translations/zh-CN/content/code-security/getting-started/securing-your-organization.md,rendering error
|
||||
translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md,rendering error
|
||||
translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md,rendering error
|
||||
translations/zh-CN/content/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning.md,rendering error
|
||||
translations/zh-CN/content/code-security/security-overview/about-the-security-overview.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,parsing error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,broken liquid tags
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md,rendering error
|
||||
translations/zh-CN/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md,Listed in localization-support#489
|
||||
@@ -172,15 +174,16 @@ translations/zh-CN/content/code-security/supply-chain-security/understanding-you
|
||||
translations/zh-CN/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/index.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md,broken liquid tags
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md,rendering error
|
||||
translations/zh-CN/content/codespaces/customizing-your-codespace/setting-your-timeout-period-for-codespaces.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/deleting-a-codespace.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/index.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,broken liquid tags
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md,rendering error
|
||||
translations/zh-CN/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md,rendering error
|
||||
translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization.md,rendering error
|
||||
translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md,rendering error
|
||||
@@ -195,53 +198,53 @@ translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/set
|
||||
translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces.md,rendering error
|
||||
translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md,rendering error
|
||||
translations/zh-CN/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error
|
||||
translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md,broken liquid tags
|
||||
translations/zh-CN/content/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam.md,rendering error
|
||||
translations/zh-CN/content/communities/maintaining-your-safety-on-github/unblocking-a-user-from-your-organization.md,rendering error
|
||||
translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,broken liquid tags
|
||||
translations/zh-CN/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-an-existing-project-to-github-using-github-desktop.md,rendering error
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md,rendering error
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github.md,rendering error
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md,rendering error
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md,rendering error
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,rendering error
|
||||
translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,rendering error
|
||||
translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md,rendering error
|
||||
translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md,rendering error
|
||||
translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md,rendering error
|
||||
translations/zh-CN/content/developers/apps/getting-started-with-apps/activating-optional-features-for-apps.md,rendering error
|
||||
translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,rendering error
|
||||
translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,rendering error
|
||||
translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/index.md,rendering error
|
||||
translations/zh-CN/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md,rendering error
|
||||
translations/zh-CN/content/developers/overview/managing-deploy-keys.md,rendering error
|
||||
translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md,broken liquid tags
|
||||
translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md,broken liquid tags
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md,broken liquid tags
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md,broken liquid tags
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md,broken liquid tags
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md,broken liquid tags
|
||||
translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md,broken liquid tags
|
||||
translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md,broken liquid tags
|
||||
translations/zh-CN/content/developers/overview/secret-scanning-partner-program.md,rendering error
|
||||
translations/zh-CN/content/developers/webhooks-and-events/webhooks/about-webhooks.md,rendering error
|
||||
translations/zh-CN/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md,rendering error
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-campus-advisors.md,rendering error
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md,rendering error
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/index.md,rendering error
|
||||
translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/why-wasnt-my-application-for-a-student-developer-pack-approved.md,rendering error
|
||||
translations/zh-CN/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md,rendering error
|
||||
translations/zh-CN/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md,rendering error
|
||||
translations/zh-CN/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md,rendering error
|
||||
translations/zh-CN/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md,rendering error
|
||||
translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md,broken liquid tags
|
||||
translations/zh-CN/content/get-started/quickstart/communicating-on-github.md,broken liquid tags
|
||||
translations/zh-CN/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error
|
||||
translations/zh-CN/content/get-started/quickstart/communicating-on-github.md,rendering error
|
||||
translations/zh-CN/content/get-started/quickstart/create-a-repo.md,rendering error
|
||||
translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md,broken liquid tags
|
||||
translations/zh-CN/content/get-started/quickstart/github-flow.md,broken liquid tags
|
||||
translations/zh-CN/content/get-started/quickstart/git-and-github-learning-resources.md,rendering error
|
||||
translations/zh-CN/content/get-started/quickstart/github-flow.md,rendering error
|
||||
translations/zh-CN/content/get-started/using-git/about-git.md,rendering error
|
||||
translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md,broken liquid tags
|
||||
translations/zh-CN/content/get-started/using-git/dealing-with-non-fast-forward-errors.md,rendering error
|
||||
translations/zh-CN/content/get-started/using-git/getting-changes-from-a-remote-repository.md,rendering error
|
||||
translations/zh-CN/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md,rendering error
|
||||
translations/zh-CN/content/get-started/using-github/github-for-mobile.md,broken liquid tags
|
||||
translations/zh-CN/content/get-started/using-github/github-for-mobile.md,rendering error
|
||||
translations/zh-CN/content/get-started/using-github/keyboard-shortcuts.md,rendering error
|
||||
translations/zh-CN/content/github-cli/github-cli/creating-github-cli-extensions.md,rendering error
|
||||
translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md,broken liquid tags
|
||||
translations/zh-CN/content/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace.md,rendering error
|
||||
translations/zh-CN/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md,rendering error
|
||||
translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md,broken liquid tags
|
||||
translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md,broken liquid tags
|
||||
translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md,broken liquid tags
|
||||
translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md,broken liquid tags
|
||||
translations/zh-CN/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md,rendering error
|
||||
translations/zh-CN/content/github/working-with-github-support/about-github-premium-support-for-github-enterprise-cloud.md,rendering error
|
||||
translations/zh-CN/content/github/working-with-github-support/github-enterprise-cloud-support.md,rendering error
|
||||
translations/zh-CN/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md,rendering error
|
||||
translations/zh-CN/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error
|
||||
translations/zh-CN/content/github/writing-on-github/working-with-advanced-formatting/index.md,rendering error
|
||||
translations/zh-CN/content/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md,rendering error
|
||||
@@ -249,12 +252,12 @@ translations/zh-CN/content/graphql/guides/index.md,rendering error
|
||||
translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md,rendering error
|
||||
translations/zh-CN/content/issues/trying-out-the-new-projects-experience/customizing-your-project-views.md,rendering error
|
||||
translations/zh-CN/content/issues/trying-out-the-new-projects-experience/managing-access-to-projects.md,rendering error
|
||||
translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md,broken liquid tags
|
||||
translations/zh-CN/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md,rendering error
|
||||
translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,broken liquid tags
|
||||
translations/zh-CN/content/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization.md,rendering error
|
||||
@@ -262,28 +265,28 @@ translations/zh-CN/content/organizations/managing-organization-settings/restrict
|
||||
translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/index.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md,rendering error
|
||||
translations/zh-CN/content/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management.md,rendering error
|
||||
translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md,broken liquid tags
|
||||
translations/zh-CN/content/organizations/organizing-members-into-teams/about-teams.md,rendering error
|
||||
translations/zh-CN/content/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md,rendering error
|
||||
translations/zh-CN/content/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md,rendering error
|
||||
translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/quickstart.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,broken liquid tags
|
||||
translations/zh-CN/content/packages/learn-github-packages/deleting-a-package.md,rendering error
|
||||
translations/zh-CN/content/packages/learn-github-packages/installing-a-package.md,rendering error
|
||||
translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md,rendering error
|
||||
translations/zh-CN/content/packages/learn-github-packages/publishing-a-package.md,rendering error
|
||||
translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md,rendering error
|
||||
translations/zh-CN/content/packages/quickstart.md,rendering error
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md,rendering error
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md,rendering error
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md,rendering error
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md,rendering error
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,rendering error
|
||||
translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,rendering error
|
||||
translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/pages/getting-started-with-github-pages/about-github-pages.md,rendering error
|
||||
translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,broken liquid tags
|
||||
translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md,broken liquid tags
|
||||
translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md,broken liquid tags
|
||||
translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md,rendering error
|
||||
translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md,rendering error
|
||||
translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md,rendering error
|
||||
translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md,rendering error
|
||||
translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,broken liquid tags
|
||||
translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,rendering error
|
||||
translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md,rendering error
|
||||
translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md,rendering error
|
||||
translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md,rendering error
|
||||
@@ -299,25 +302,25 @@ translations/zh-CN/content/repositories/creating-and-managing-repositories/trans
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md,rendering error
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md,rendering error
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md,rendering error
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md,broken liquid tags
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md,rendering error
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md,rendering error
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md,rendering error
|
||||
translations/zh-CN/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md,rendering error
|
||||
translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md,broken liquid tags
|
||||
translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md,broken liquid tags
|
||||
translations/zh-CN/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md,rendering error
|
||||
translations/zh-CN/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md,rendering error
|
||||
translations/zh-CN/content/rest/guides/basics-of-authentication.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/rest/guides/basics-of-authentication.md,rendering error
|
||||
translations/zh-CN/content/rest/guides/discovering-resources-for-a-user.md,rendering error
|
||||
translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md,broken liquid tags
|
||||
translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md,rendering error
|
||||
translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md,rendering error
|
||||
translations/zh-CN/content/rest/overview/api-previews.md,rendering error
|
||||
translations/zh-CN/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/rest/overview/other-authentication-methods.md,rendering error
|
||||
translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,Listed in localization-support#489
|
||||
translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,rendering error
|
||||
translations/zh-CN/content/rest/reference/activity.md,broken liquid tags
|
||||
translations/zh-CN/content/rest/reference/apps.md,broken liquid tags
|
||||
translations/zh-CN/content/rest/reference/enterprise-admin.md,broken liquid tags
|
||||
translations/zh-CN/content/rest/reference/activity.md,rendering error
|
||||
translations/zh-CN/content/rest/reference/apps.md,rendering error
|
||||
translations/zh-CN/content/rest/reference/enterprise-admin.md,rendering error
|
||||
translations/zh-CN/content/rest/reference/permissions-required-for-github-apps.md,rendering error
|
||||
translations/zh-CN/content/rest/reference/repos.md,rendering error
|
||||
translations/zh-CN/content/rest/reference/search.md,rendering error
|
||||
@@ -327,8 +330,8 @@ translations/zh-CN/content/search-github/searching-on-github/searching-commits.m
|
||||
translations/zh-CN/content/search-github/searching-on-github/searching-discussions.md,rendering error
|
||||
translations/zh-CN/content/search-github/searching-on-github/searching-for-repositories.md,rendering error
|
||||
translations/zh-CN/content/search-github/searching-on-github/searching-issues-and-pull-requests.md,rendering error
|
||||
translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,broken liquid tags
|
||||
translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md,broken liquid tags
|
||||
translations/zh-CN/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,rendering error
|
||||
translations/zh-CN/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md,rendering error
|
||||
translations/zh-CN/data/release-notes/enterprise-server/2-20/15.yml,Listed in localization-support#489
|
||||
translations/zh-CN/data/release-notes/enterprise-server/2-21/6.yml,Listed in localization-support#489
|
||||
translations/zh-CN/data/reusables/apps/deprecating_auth_with_query_parameters.md,Listed in localization-support#489
|
||||
|
||||
|
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitHub Actions 的元数据语法
|
||||
shortTitle: 元数据语法
|
||||
intro: 您可以创建操作来执行仓库中的任务。 操作需要使用 YAML 语法的元数据文件。
|
||||
title: Metadata syntax for GitHub Actions
|
||||
shortTitle: Metadata syntax
|
||||
intro: You can create actions to perform tasks in your repository. Actions require a metadata file that uses YAML syntax.
|
||||
redirect_from:
|
||||
- /articles/metadata-syntax-for-github-actions
|
||||
- /github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions
|
||||
@@ -19,31 +19,31 @@ type: reference
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
|
||||
## 关于 {% data variables.product.prodname_actions %} 的 YAML 语法
|
||||
## About YAML syntax for {% data variables.product.prodname_actions %}
|
||||
|
||||
Docker 和 JavaScript 操作需要元数据文件。 元数据文件名必须是 `action.yml` 或 `action.yaml`。 元数据文件中的数据定义操作的输入、输出和主要进入点。
|
||||
Docker and JavaScript actions require a metadata file. The metadata filename must be either `action.yml` or `action.yaml`. The data in the metadata file defines the inputs, outputs and main entrypoint for your action.
|
||||
|
||||
操作元数据文件使用 YAML 语法。 如果您是 YAML 的新用户，请参阅“[五分钟了解 YAML](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)”。
|
||||
Action metadata files use YAML syntax. If you're new to YAML, you can read "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)."
|
||||
|
||||
## `name`
|
||||
|
||||
**必要** 操作的名称。 {% data variables.product.prodname_dotcom %} 在 **Actions（操作）**选项卡中显示 `name`，帮助从视觉上识别每项作业中的操作。
|
||||
**Required** The name of your action. {% data variables.product.prodname_dotcom %} displays the `name` in the **Actions** tab to help visually identify actions in each job.
|
||||
|
||||
## `作者`
|
||||
## `author`
|
||||
|
||||
**可选** 操作的作者姓名。
|
||||
**Optional** The name of the action's author.
|
||||
|
||||
## `说明`
|
||||
## `description`
|
||||
|
||||
**必要** 操作的简短描述。
|
||||
**Required** A short description of the action.
|
||||
|
||||
## `inputs`
|
||||
|
||||
**可选** 输入参数用于指定操作在运行时预期使用的数据。 {% data variables.product.prodname_dotcom %} 将输入参数存储为环境变量。 大写的输入 ID 在运行时转换为小写。 建议使用小写输入 ID。
|
||||
**Optional** Input parameters allow you to specify data that the action expects to use during runtime. {% data variables.product.prodname_dotcom %} stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.
|
||||
|
||||
### 示例
|
||||
### Example
|
||||
|
||||
此示例配置两个输入：numOctocats 和 octocatEyeColor。 numOctocats 输入不是必要的，默认值为 '1'。 octocatEyeColor 输入是必要的，没有默认值。 使用此操作的工作流程文件必须使用 `with` 关键词来设置 octocatEyeColor 的输入值。 有关 `with` 语法的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepswith)”。
|
||||
This example configures two inputs: numOctocats and octocatEyeColor. The numOctocats input is not required and will default to a value of '1'. The octocatEyeColor input is required and has no default value. Workflow files that use this action must use the `with` keyword to set an input value for octocatEyeColor. For more information about the `with` syntax, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepswith)."
|
||||
|
||||
```yaml
|
||||
inputs:
|
||||
@@ -56,41 +56,41 @@ inputs:
|
||||
required: true
|
||||
```
|
||||
|
||||
在指定工作流程文件中输入或者使用默认输入值时，{% data variables.product.prodname_dotcom %} 将为名称为 `INPUT_<VARIABLE_NAME>` 的输入创建环境变量。 创建的环境变量将输入名称转换为大写，并将空格替换为 `_` 字符。
|
||||
When you specify an input in a workflow file or use a default input value, {% data variables.product.prodname_dotcom %} creates an environment variable for the input with the name `INPUT_<VARIABLE_NAME>`. The environment variable created converts input names to uppercase letters and replaces spaces with `_` characters.
|
||||
|
||||
如果该操作是使用 [复合](/actions/creating-actions/creating-a-composite-action)编写的，则它不会自动获得 `INPUT_<VARIABLE_NAME>`。 如果不进行转换，您可以手动更改这些输入。
|
||||
If the action is written using a [composite](/actions/creating-actions/creating-a-composite-action), then it will not automatically get `INPUT_<VARIABLE_NAME>`. If the conversion doesn't occur, you can change these inputs manually.
|
||||
|
||||
要访问 Docker 容器操作中的环境变量，您必须使用操作元数据文件中的关键字 `args` 传递输入。 有关 Docker 容器操作的操作元数据文件的更多信息，请参阅“[创建 Docker 容器操作](/articles/creating-a-docker-container-action#creating-an-action-metadata-file)”。
|
||||
To access the environment variable in a Docker container action, you must pass the input using the `args` keyword in the action metadata file. For more information about the action metadata file for Docker container actions, see "[Creating a Docker container action](/articles/creating-a-docker-container-action#creating-an-action-metadata-file)."
|
||||
|
||||
例如，如果工作流程定义了 `numOctocats` 和 `octocatEyeColor` 输入，操作代码可使用 `INPUT_NUMOCTOCATS` 和 `INPUT_OCTOCATEYECOLOR` 环境变量读取输入的值。
|
||||
For example, if a workflow defined the `numOctocats` and `octocatEyeColor` inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables.
|
||||
|
||||
### `inputs.<input_id>`
|
||||
|
||||
**必要** 要与输入关联的 `string` 识别符。 `<input_id>` 的值是输入元数据的映射。 `<input_id>` 必须是 `inputs` 对象中的唯一识别符。 `<input_id>` 必须以字母或 `_` 开头，并且只能包含字母数字、`-` 或 `_`。
|
||||
**Required** A `string` identifier to associate with the input. The value of `<input_id>` is a map of the input's metadata. The `<input_id>` must be a unique identifier within the `inputs` object. The `<input_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
|
||||
|
||||
### `inputs.<input_id>.description`
|
||||
|
||||
**必要** 输入参数的 `string` 描述。
|
||||
**Required** A `string` description of the input parameter.
|
||||
|
||||
### `inputs.<input_id>.required`
|
||||
|
||||
**必要** 表示操作是否需要输入参数的 `boolean`。 当参数为必要时设置为 `true`。
|
||||
**Required** A `boolean` to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.
|
||||
|
||||
### `inputs.<input_id>.default`
|
||||
|
||||
**可选** 表示默认值的 `string`。 当工作流程文件中未指定输入参数时使用默认值。
|
||||
**Optional** A `string` representing the default value. The default value is used when an input parameter isn't specified in a workflow file.
|
||||
|
||||
### `inputs.<input_id>.deprecationMessage`
|
||||
|
||||
**可选** 如果使用输入参数，此 `string` 将记录为警告消息。 您可以使用此警告通知用户输入已被弃用，并提及任何其他替代方式。
|
||||
**Optional** If the input parameter is used, this `string` is logged as a warning message. You can use this warning to notify users that the input is deprecated and mention any alternatives.
|
||||
|
||||
## `outputs`
|
||||
|
||||
**可选** 输出参数允许您声明操作所设置的数据。 稍后在工作流程中运行的操作可以使用以前运行操作中的输出数据集。 例如，如果有操作执行两个输入的相加 (x + y = z)，则该操作可能输出总和 (z)，用作其他操作的输入。
|
||||
**Optional** Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.
|
||||
|
||||
如果不在操作元数据文件中声明输出，您仍然可以设置输出并在工作流程中使用它们。 有关在操作中设置输出的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程命令](/actions/reference/workflow-commands-for-github-actions/#setting-an-output-parameter)”。
|
||||
If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. For more information on setting outputs in an action, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-output-parameter)."
|
||||
|
||||
### 示例
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
outputs:
|
||||
@@ -100,25 +100,19 @@ outputs:
|
||||
|
||||
### `outputs.<output_id>`
|
||||
|
||||
**必要** 要与输出关联的 `string` 识别符。 `<output_id>` 的值是输出元数据的映射。 `<output_id>` 必须是 `outputs` 对象中的唯一识别符。 `<output_id>` 必须以字母或 `_` 开头，并且只能包含字母数字、`-` 或 `_`。
|
||||
**Required** A `string` identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the `outputs` object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
|
||||
|
||||
### `outputs.<output_id>.description`
|
||||
|
||||
**必要** 输出参数的 `string` 描述。
|
||||
**Required** A `string` description of the output parameter.
|
||||
|
||||
## 用于复合操作的 `outputs`
|
||||
## `outputs` for composite actions
|
||||
|
||||
**可选** `outputs` 使用与 `outputs.<output_id>` 及 `outputs.<output_id>.description` 相同的参数（请参阅“用于 {% data variables.product.prodname_actions %}</a> 的
|
||||
**Optional** `outputs` use the same parameters as `outputs.<output_id>` and `outputs.<output_id>.description` (see "[`outputs` for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions#outputs)"), but also includes the `value` token.
|
||||
|
||||
`outputs`”），但也包括 `value` 令牌。</p>
|
||||
|
||||
|
||||
|
||||
### 示例
|
||||
### Example
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
```yaml
|
||||
outputs:
|
||||
random-number:
|
||||
@@ -131,29 +125,23 @@ runs:
|
||||
run: echo "::set-output name=random-id::$(echo $RANDOM)"
|
||||
shell: bash
|
||||
```
|
||||
|
||||
|
||||
{% endraw %}
|
||||
|
||||
|
||||
|
||||
### `outputs.<output_id>.value`
|
||||
|
||||
**必要** 输出参数将会映射到的值。 您可以使用上下文将此设置为 `string` 或表达式。 例如，您可以使用 `steps` 上下文将输出的 `value` 设置为步骤的输出值。
|
||||
**Required** The value that the output parameter will be mapped to. You can set this to a `string` or an expression with context. For example, you can use the `steps` context to set the `value` of an output to the output value of a step.
|
||||
|
||||
有关如何使用上下文语法的更多信息，请参阅“[上下文](/actions/learn-github-actions/contexts)”。
|
||||
For more information on how to use context syntax, see "[Contexts](/actions/learn-github-actions/contexts)."
|
||||
|
||||
## `runs`
|
||||
|
||||
**Required** Specifies whether this is a JavaScript action, a composite action or a Docker action and how the action is executed.
|
||||
|
||||
## 用于 JavaScript 操作的 `runs`
|
||||
|
||||
**必要** 配置操作代码的路径和用于执行代码的应用程序。
|
||||
|
||||
|
||||
|
||||
### 使用 Node.js 的示例
|
||||
## `runs` for JavaScript actions
|
||||
|
||||
**Required** Configures the path to the action's code and the runtime used to execute the code.
|
||||
|
||||
### Example using Node.js v12
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -161,28 +149,22 @@ runs:
|
||||
main: 'main.js'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `runs.using`
|
||||
|
||||
**必要** 用于执行 [`main`](#runsmain) 中指定的代码的应用程序。
|
||||
|
||||
**Required** The runtime used to execute the code specified in [`main`](#runsmain).
|
||||
|
||||
- Use `node12` for Node.js v12.
|
||||
- Use `node16` for Node.js v16.
|
||||
|
||||
### `runs.main`
|
||||
|
||||
**必要** 包含操作代码的文件。 [`using`](#runsusing) 中指定的应用程序执行此文件。
|
||||
|
||||
|
||||
**Required** The file that contains your action code. The runtime specified in [`using`](#runsusing) executes this file.
|
||||
|
||||
### `pre`
|
||||
|
||||
**可选** 允许您在 `main:` 操作开始之前，在作业开始时运行脚本。 例如，您可以使用 `pre:` 运行基本要求设置脚本。 使用 [`using`](#runsusing) 语法指定的应用程序将执行此文件。 `pre:` 操作始终默认运行，但您可以使用 [`pre-if`](#pre-if) 覆盖该设置。
|
||||
|
||||
在此示例中，`pre:` 操作运行名为 `setup.js` 的脚本：
|
||||
|
||||
**Optional** Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The runtime specified with the [`using`](#runsusing) syntax will execute this file. The `pre:` action always runs by default but you can override this using [`pre-if`](#pre-if).
|
||||
|
||||
In this example, the `pre:` action runs a script called `setup.js`:
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -192,32 +174,23 @@ runs:
|
||||
post: 'cleanup.js'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `pre-if`
|
||||
|
||||
**可选** 允许您定义 `pre:` 操作执行的条件。 `pre:` 操作仅在满足 `pre-if` 中的条件后运行。 如果未设置，则 `pre-if` 默认使用 `always()`。 请注意，`step` 上下文不可用，因为尚未运行任何步骤。
|
||||
|
||||
在此示例中，`cleanup.js` 仅在基于 Linux 的运行器上运行：
|
||||
|
||||
**Optional** Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`.
|
||||
Note that the `step` context is unavailable, as no steps have run yet.
|
||||
|
||||
In this example, `cleanup.js` only runs on Linux-based runners:
|
||||
|
||||
```yaml
|
||||
pre: 'cleanup.js'
|
||||
pre-if: runner.os == 'linux'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `post`
|
||||
|
||||
**可选** 允许您在 `main:` 操作完成后，在作业结束时运行脚本。 例如，您可以使用 `post:` 终止某些进程或删除不需要的文件。 使用 [`using`](#runsusing) 语法指定的应用程序将执行此文件。
|
||||
|
||||
在此示例中，`post:` 操作会运行名为 `cleanup.js` 的脚本：
|
||||
|
||||
**Optional** Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The runtime specified with the [`using`](#runsusing) syntax will execute this file.
|
||||
|
||||
In this example, the `post:` action runs a script called `cleanup.js`:
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -226,70 +199,44 @@ runs:
|
||||
post: 'cleanup.js'
|
||||
```
|
||||
|
||||
|
||||
`post:` 操作始终默认运行，但您可以使用 `post-if` 覆盖该设置。
|
||||
|
||||
|
||||
The `post:` action always runs by default but you can override this using `post-if`.
|
||||
|
||||
### `post-if`
|
||||
|
||||
**可选** 允许您定义 `post:` 操作执行的条件。 `post:` 操作仅在满足 `post-if` 中的条件后运行。 如果未设置，则 `post-if` 默认使用 `always()`。
|
||||
|
||||
例如，此 `cleanup.js` 仅在基于 Linux 的运行器上运行：
|
||||
|
||||
**Optional** Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.
|
||||
|
||||
For example, this `cleanup.js` will only run on Linux-based runners:
|
||||
|
||||
```yaml
|
||||
post: 'cleanup.js'
|
||||
post-if: runner.os == 'linux'
|
||||
```
|
||||
|
||||
## `runs` for composite actions
|
||||
|
||||
|
||||
|
||||
## 用于复合操作的 `runs`
|
||||
|
||||
**必要** 配置组合操作的路径和用于执行代码的应用程序。
|
||||
|
||||
|
||||
**Required** Configures the path to the composite action.
|
||||
|
||||
### `runs.using`
|
||||
|
||||
**必要** 要使用复合操作，请将此设置为 `"composite"`。
|
||||
|
||||
|
||||
**Required** You must set this value to `'composite'`.
|
||||
|
||||
### `runs.steps`
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
|
||||
|
||||
**必要** 您计划在此操作中的步骤。 这些步骤可以是 `run` 步骤或 `uses` 步骤。
|
||||
|
||||
**Required** The steps that you plan to run in this action. These can be either `run` steps or `uses` steps.
|
||||
{% else %}
|
||||
|
||||
**必要** 您计划在此操作中的步骤。
|
||||
|
||||
**Required** The steps that you plan to run in this action.
|
||||
{% endif %}
|
||||
|
||||
|
||||
|
||||
#### `runs.steps[*].run`
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
|
||||
|
||||
**可选** 您想要运行的命令。 这可以是内联的，也可以是操作仓库中的脚本：
|
||||
|
||||
**Optional** The command you want to run. This can be inline or a script in your action repository:
|
||||
{% else %}
|
||||
|
||||
**必要** 您想要运行的命令。 这可以是内联的，也可以是操作仓库中的脚本：
|
||||
|
||||
**Required** The command you want to run. This can be inline or a script in your action repository:
|
||||
{% endif %}
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
using: "composite"
|
||||
@@ -297,13 +244,9 @@ runs:
|
||||
- run: ${{ github.action_path }}/test/script.sh
|
||||
shell: bash
|
||||
```
|
||||
|
||||
|
||||
{% endraw %}
|
||||
|
||||
或者，您也可以使用 `$GITHUB_ACTION_PATH`：
|
||||
|
||||
|
||||
Alternatively, you can use `$GITHUB_ACTION_PATH`:
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -313,64 +256,43 @@ runs:
|
||||
shell: bash
|
||||
```
|
||||
|
||||
|
||||
更多信息请参阅“[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)”。
|
||||
|
||||
|
||||
For more information, see "[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)".
|
||||
|
||||
#### `runs.steps[*].shell`
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
|
||||
|
||||
**可选** 您想要在其中运行命令的 shell。 您可以使用[这里](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell)列出的任何 shell。 如果设置了 `run`，则必填。
|
||||
|
||||
**Optional** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Required if `run` is set.
|
||||
{% else %}
|
||||
|
||||
**必要** 您想要在其中运行命令的 shell。 您可以使用[这里](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell)列出的任何 shell。 如果设置了 `run`，则必填。
|
||||
|
||||
**Required** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Required if `run` is set.
|
||||
{% endif %}
|
||||
|
||||
|
||||
|
||||
#### `runs.steps[*].name`
|
||||
|
||||
**可选** 复合步骤的名称。
|
||||
|
||||
|
||||
**Optional** The name of the composite step.
|
||||
|
||||
#### `runs.steps[*].id`
|
||||
|
||||
**可选** 步骤的唯一标识符。 您可以使用 `id` 引用上下文中的步骤。 更多信息请参阅“[上下文](/actions/learn-github-actions/contexts)”。
|
||||
|
||||
|
||||
**Optional** A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."
|
||||
|
||||
#### `runs.steps[*].env`
|
||||
|
||||
**可选** 设置环境变量的 `map` 仅用于该步骤。 If you want to modify the environment variable stored in the workflow, use `echo "{name}={value}" >> $GITHUB_ENV` in a composite step.
|
||||
|
||||
|
||||
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use `echo "{name}={value}" >> $GITHUB_ENV` in a composite step.
|
||||
|
||||
#### `runs.steps[*].working-directory`
|
||||
|
||||
**可选** 指定命令在其中运行的工作目录。
|
||||
**Optional** Specifies the working directory where the command is run.
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
|
||||
|
||||
#### `runs.steps[*].uses`
|
||||
|
||||
**可选** 选择作为作业步骤一部分运行的操作。 操作是一种可重复使用的代码单位。 您可以使用工作流程所在仓库中、公共仓库中或[发布 Docker 容器映像](https://hub.docker.com/)中定义的操作。
|
||||
|
||||
强烈建议指定 Git ref、SHA 或 Docker 标记编号来包含所用操作的版本。 如果不指定版本，在操作所有者发布更新时可能会中断您的工作流程或造成非预期的行为。
|
||||
|
||||
- 使用已发行操作版本的 SHA 对于稳定性和安全性是最安全的。
|
||||
- 使用特定主要操作版本可在保持兼容性的同时接收关键修复和安全补丁。 还可确保您的工作流程继续工作。
|
||||
- 使用操作的默认分支可能很方便，但如果有人新发布具有突破性更改的主要版本，您的工作流程可能会中断。
|
||||
|
||||
有些操作要求必须通过 [`with`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) 关键词设置输入。 请查阅操作的自述文件，确定所需的输入。
|
||||
**Optional** Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/).
|
||||
|
||||
We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.
|
||||
- Using the commit SHA of a released action version is the safest for stability and security.
|
||||
- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.
|
||||
- Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.
|
||||
|
||||
Some actions require inputs that you must set using the [`with`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required.
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -394,14 +316,9 @@ runs:
|
||||
- uses: docker://alpine:3.8
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
#### `runs.steps[*].with`
|
||||
|
||||
**可选** 输入参数的 `map` 由操作定义。 每个输入参数都是一个键/值对。 输入参数被设置为环境变量。 该变量的前缀为 INPUT_，并转换为大写。
|
||||
|
||||
|
||||
**Optional** A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -414,21 +331,13 @@ runs:
|
||||
middle_name: The
|
||||
last_name: Octocat
|
||||
```
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
## `runs` for Docker actions
|
||||
|
||||
**Required** Configures the image used for the Docker action.
|
||||
|
||||
## 用于 Docker 操作的 `runs`
|
||||
|
||||
**必要** 配置用于 Docker 操作的图像。
|
||||
|
||||
|
||||
|
||||
### 在仓库中使用 Dockerfile 的示例
|
||||
|
||||
|
||||
### Example using a Dockerfile in your repository
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -436,12 +345,7 @@ runs:
|
||||
image: 'Dockerfile'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### 使用公共 Docker 注册表容器的示例
|
||||
|
||||
|
||||
### Example using public Docker registry container
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -449,24 +353,17 @@ runs:
|
||||
image: 'docker://debian:stretch-slim'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `runs.using`
|
||||
|
||||
**必要** 必须将此值设置为 `'docker'`。
|
||||
|
||||
|
||||
**Required** You must set this value to `'docker'`.
|
||||
|
||||
### `pre-entrypoint`
|
||||
|
||||
**可选** 允许您在 `entrypoint` 操作开始之前运行脚本。 例如，您可以使用 `pre-entrypoint:` 运行基本要求设置脚本。 {% data variables.product.prodname_actions %} 使用 `docker run` 启动此操作，并在使用同一基本映像的新容器中运行脚本。 这意味着运行时状态与主 `entrypoint` 容器不同，并且必须在任一工作空间中访问所需的任何状态，`HOME` 或作为 `STATE_` 变量。 `pre-entrypoint:` 操作始终默认运行，但您可以使用 [`pre-if`](#pre-if) 覆盖该设置。
|
||||
|
||||
使用 [`using`](#runsusing) 语法指定的应用程序将执行此文件。
|
||||
|
||||
在此示例中，`pre-entrypoint:` 操作会运行名为 `setup.sh` 的脚本：
|
||||
**Optional** Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. {% data variables.product.prodname_actions %} uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using [`pre-if`](#pre-if).
|
||||
|
||||
The runtime specified with the [`using`](#runsusing) syntax will execute this file.
|
||||
|
||||
In this example, the `pre-entrypoint:` action runs a script called `setup.sh`:
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -478,34 +375,23 @@ runs:
|
||||
entrypoint: 'main.sh'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `runs.image`
|
||||
|
||||
**必要** 要用作容器来运行操作的 Docker 映像。 值可以是 Docker 基本映像名称、仓库中的本地 `Dockerfile`、Docker Hub 中的公共映像或另一个注册表。 要引用仓库本地的 `Dockerfile`，文件必须命名为 `Dockerfile`，并且您必须使用操作元数据文件的相对路径。 `Docker` 应用程序将执行此文件。
|
||||
|
||||
|
||||
**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, the file must be named `Dockerfile` and you must use a path relative to your action metadata file. The `docker` application will execute this file.
|
||||
|
||||
### `runs.env`
|
||||
|
||||
**可选** 指定要在容器环境中设置的环境变量的键/值映射。
|
||||
|
||||
|
||||
**Optional** Specifies a key/value map of environment variables to set in the container environment.
|
||||
|
||||
### `runs.entrypoint`
|
||||
|
||||
**可选** 覆盖 `Dockerfile` 中的 Docker `ENTRYPOINT`，或在未指定时设置它。 当 `Dockerfile` 未指定 `ENTRYPOINT` 或者您想要覆盖 `ENTRYPOINT` 指令时使用 `entrypoint`。 如果您省略 `entrypoint`，您在 Docker `ENTRYPOINT` 指令中指定的命令将执行。 Docker `ENTRYPOINT` 指令有 _shell_ 形式和 _exec_ 形式。 Docker `ENTRYPOINT` 文档建议使用 _exec_ 形式的 `ENTRYPOINT` 指令。
|
||||
|
||||
有关 `entrypoint` 如何执行的更多信息，请参阅“[Dockerfile 对 {% data variables.product.prodname_actions %} 的支持](/actions/creating-actions/dockerfile-support-for-github-actions/#entrypoint)”。
|
||||
|
||||
**Optional** Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT` instruction has a _shell_ form and _exec_ form. The Docker `ENTRYPOINT` documentation recommends using the _exec_ form of the `ENTRYPOINT` instruction.
|
||||
|
||||
For more information about how the `entrypoint` executes, see "[Dockerfile support for {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#entrypoint)."
|
||||
|
||||
### `post-entrypoint`
|
||||
|
||||
**可选** 允许您在 `runs.entrypoint` 操作完成后运行清理脚本。 {% data variables.product.prodname_actions %} 使用 `docker run` 来启动此操作。 因为 {% data variables.product.prodname_actions %} 使用同一基本映像在新容器内运行脚本，所以运行时状态与主 `entrypoint` 容器不同。 您可以在任一工作空间中访问所需的任何状态，`HOME` 或作为 `STATE_` 变量。 `post-entrypoint:` 操作始终默认运行，但您可以使用 [`post-if`](#post-if) 覆盖该设置。
|
||||
|
||||
|
||||
**Optional** Allows you to run a cleanup script once the `runs.entrypoint` action has completed. {% data variables.product.prodname_actions %} uses `docker run` to launch this action. Because {% data variables.product.prodname_actions %} runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using [`post-if`](#post-if).
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
@@ -517,28 +403,21 @@ runs:
|
||||
post-entrypoint: 'cleanup.sh'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `runs.args`
|
||||
|
||||
**可选** 定义 Docker 容器输入的字符串数组。 输入可包含硬编码的字符串。 {% data variables.product.prodname_dotcom %} 在容器启动时将 `args` 传递到容器的 `ENTRYPOINT`。
|
||||
**Optional** An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up.
|
||||
|
||||
`args` 用来代替 `Dockerfile` 中的 `CMD` 指令。 如果在 `Dockerfile` 中使用 `CMD`，请遵循按偏好顺序排序的指导方针：
|
||||
The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:
|
||||
|
||||
{% data reusables.github-actions.dockerfile-guidelines %}
|
||||
|
||||
如果需要将环境变量传递到操作中，请确保操作运行命令 shell 以执行变量替换。 例如，如果 `entrypoint` 属性设置为 `"sh -c"`，`args` 将在命令 shell 中运行。 或者，如果 `Dockerfile` 使用 `ENTRYPOINT` 运行同一命令 (`"sh -c"`)，`args` 将在命令 shell 中执行。
|
||||
If you need to pass environment variables into an action, make sure your action runs a command shell to perform variable substitution. For example, if your `entrypoint` attribute is set to `"sh -c"`, `args` will be run in a command shell. Alternatively, if your `Dockerfile` uses an `ENTRYPOINT` to run the same command (`"sh -c"`), `args` will execute in a command shell.
|
||||
|
||||
有关将 `CMD` 指令与 {% data variables.product.prodname_actions %} 一起使用的更多信息，请参阅“[Dockerfile 对 {% data variables.product.prodname_actions %} 的支持](/actions/creating-actions/dockerfile-support-for-github-actions/#cmd)”。
|
||||
For more information about using the `CMD` instruction with {% data variables.product.prodname_actions %}, see "[Dockerfile support for {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#cmd)."
|
||||
|
||||
|
||||
|
||||
#### 示例
|
||||
#### Example
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
```yaml
|
||||
runs:
|
||||
using: 'docker'
|
||||
@@ -548,21 +427,13 @@ runs:
|
||||
- 'foo'
|
||||
- 'bar'
|
||||
```
|
||||
|
||||
|
||||
{% endraw %}
|
||||
|
||||
|
||||
|
||||
## `branding`
|
||||
|
||||
您可以使用颜色和 [Feather](https://feathericons.com/) 图标创建徽章，以个性化和识别操作。 徽章显示在 [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions) 中的操作名称旁边。
|
||||
|
||||
|
||||
|
||||
### 示例
|
||||
|
||||
You can use a color and [Feather](https://feathericons.com/) icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions).
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
branding:
|
||||
@@ -570,18 +441,13 @@ branding:
|
||||
color: 'green'
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### `branding.color`
|
||||
|
||||
徽章的背景颜色。 可以是以下之一：`white`、`yellow`、`blue`、`green`、`orange`、`red`、`purple` 或 `gray-dark`。
|
||||
|
||||
|
||||
The background color of the badge. Can be one of: `white`, `yellow`, `blue`, `green`, `orange`, `red`, `purple`, or `gray-dark`.
|
||||
|
||||
### `branding.icon`
|
||||
|
||||
要使用的 [Feather](https://feathericons.com/) 图标的名称。
|
||||
The name of the [Feather](https://feathericons.com/) icon to use.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 上下文
|
||||
shortTitle: 上下文
|
||||
title: Contexts
|
||||
shortTitle: Contexts
|
||||
intro: You can access context information in workflows and actions.
|
||||
redirect_from:
|
||||
- /articles/contexts-and-expression-syntax-for-github-actions
|
||||
@@ -24,124 +24,136 @@ miniTocMaxHeadingLevel: 3
|
||||
|
||||
{% data reusables.github-actions.context-injection-warning %}
|
||||
|
||||
上下文是一种访问工作流程运行、运行器环境、作业及步骤相关信息的方式。 上下文使用表达式语法。 For more information, see "[Expressions](/actions/learn-github-actions/expressions)."
|
||||
Contexts are a way to access information about workflow runs, runner environments, jobs, and steps. Contexts use the expression syntax. For more information, see "[Expressions](/actions/learn-github-actions/expressions)."
|
||||
|
||||
{% raw %}
|
||||
`${{ <context> }}`
|
||||
{% endraw %}
|
||||
|
||||
| 上下文名称 | 类型 | 描述 |
|
||||
| ---------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github` | `对象` | 工作流程运行的相关信息。 更多信息请参阅 [`github` 上下文](#github-context)。 |
|
||||
| `env` | `对象` | 包含工作流程、作业或步骤中设置的环境变量。 更多信息请参阅 [`env` 上下文](#env-context)。 |
|
||||
| `job` | `对象` | 当前执行的作业相关信息。 更多信息请参阅 [`job` 上下文](#job-context)。 |
|
||||
| `steps` | `对象` | 此作业中已经运行的步骤的相关信息。 更多信息请参阅 [`steps` 上下文](#steps-context)。 |
|
||||
| `runner` | `对象` | 运行当前作业的运行程序相关信息。 更多信息请参阅 [`runner` 上下文](#runner-context)。 |
|
||||
| `secrets` | `对象` | 启用对密码的访问权限。 有关密码的更多信息，请参阅“[创建和使用加密密码](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)”。 |
|
||||
| `strategy` | `对象` | 用于访问配置的策略参数及当前作业的相关信息。 策略参数包括 `fail-fast`、`job-index`、`job-total` 和 `max-parallel`。 |
|
||||
| `matrix` | `对象` | 用于访问为当前作业配置的矩阵参数。 例如，如果使用 `os` 和 `node` 版本配置矩阵构建，`matrix` 上下文对象将包含当前作业的 `os` 和 `node` 版本。 |
|
||||
| `needs` | `对象` | 允许访问定义为当前作业依赖项的所有作业的输出。 更多信息请参阅 [`needs` 上下文](#needs-context)。 |
|
||||
| Context name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `github` | `object` | Information about the workflow run. For more information, see [`github` context](#github-context). |
|
||||
| `env` | `object` | Contains environment variables set in a workflow, job, or step. For more information, see [`env` context](#env-context). |
|
||||
| `job` | `object` | Information about the currently executing job. For more information, see [`job` context](#job-context). |
|
||||
| `steps` | `object` | Information about the steps that have been run in this job. For more information, see [`steps` context](#steps-context). |
|
||||
| `runner` | `object` | Information about the runner that is running the current job. For more information, see [`runner` context](#runner-context). |
|
||||
| `secrets` | `object` | Enables access to secrets. For more information about secrets, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." |
|
||||
| `strategy` | `object` | Enables access to the configured strategy parameters and information about the current job. Strategy parameters include `fail-fast`, `job-index`, `job-total`, and `max-parallel`. |
|
||||
| `matrix` | `object` | Enables access to the matrix parameters you configured for the current job. For example, if you configure a matrix build with the `os` and `node` versions, the `matrix` context object includes the `os` and `node` versions of the current job. |
|
||||
| `needs` | `object` | Enables access to the outputs of all jobs that are defined as a dependency of the current job. For more information, see [`needs` context](#needs-context). |
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}| `inputs` | `object` | Enables access to the inputs of reusable workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %}
|
||||
|
||||
作为表达式的一部分，您可以使用以下两种语法之一访问上下文信息。
|
||||
- 索引语法：`github['sha']`
|
||||
- 属性解除参考语法：`github.sha`
|
||||
As part of an expression, you may access context information using one of two syntaxes.
|
||||
- Index syntax: `github['sha']`
|
||||
- Property dereference syntax: `github.sha`
|
||||
|
||||
要使用属性解除参考语法，属性名称必须：
|
||||
- 以 `a-Z` 或 `_` 开头。
|
||||
- 后跟 `a-Z` `0-9` `-` 或 `_`。
|
||||
In order to use property dereference syntax, the property name must:
|
||||
- start with `a-Z` or `_`.
|
||||
- be followed by `a-Z` `0-9` `-` or `_`.
|
||||
|
||||
### 确定何时使用上下文
|
||||
### Determining when to use contexts
|
||||
|
||||
{% data reusables.github-actions.using-context-or-environment-variables %}
|
||||
|
||||
### `github` 上下文
|
||||
### `github` context
|
||||
|
||||
`github` 上下文包含有关工作流程运行以及触发运行的事件相关信息。 您可以读取环境变量中的大多数 `github` 上下文数据。 有关环境变量的更多信息，请参阅“[使用环境变量](/actions/automating-your-workflow-with-github-actions/using-environment-variables)”。
|
||||
The `github` context contains information about the workflow run and the event that triggered the run. You can read most of the `github` context data in environment variables. For more information about environment variables, see "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)."
|
||||
|
||||
{% data reusables.github-actions.github-context-warning %}
|
||||
{% data reusables.github-actions.context-injection-warning %}
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| -------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `github` | `对象` | 工作流程中任何作业或步骤期间可用的顶层上下文。 |
|
||||
| `github.action` | `字符串` | 正在运行的操作的名称。 {% data variables.product.prodname_dotcom %} removes special characters or uses the name `__run` when the current step runs a script. If you use the same action more than once in the same job, the name will include a suffix with the sequence number with underscore before it. For example, the first script you run will have the name `__run`, and the second script will be named `__run_2`. 同样，`actions/checkout` 第二次调用时将变成 `actionscheckout2`。 |
|
||||
| `github.action_path` | `字符串` | 您的操作所在的路径。 您可以使用此路径轻松访问与操作位于同一仓库中的文件。 此属性仅在复合操作中才受支持。 |
|
||||
| `github.actor` | `字符串` | 发起工作流程运行的用户的登录名。 |
|
||||
| `github.base_ref` | `字符串` | 工作流程运行中拉取请求的 `base_ref` 或目标分支。 此属性仅在触发工作流程运行的事件为 `pull_request` 或 `pull_request_target` 时才可用。 |
|
||||
| `github.event` | `对象` | 完整事件 web 挂钩有效负载。 更多信息请参阅“[触发工作流程的事件](/articles/events-that-trigger-workflows/)”。 您可以使用上下文访问事件的个别属性。 |
|
||||
| `github.event_name` | `字符串` | 触发工作流程运行的事件的名称。 |
|
||||
| `github.event_path` | `字符串` | 运行器上完整事件 web 挂钩有效负载的路径。 |
|
||||
| `github.head_ref` | `字符串` | 工作流程运行中拉取请求的 `head_ref` 或来源分支。 此属性仅在触发工作流程运行的事件为 `pull_request` 或 `pull_request_target` 时才可用。 |
|
||||
| `github.job` | `字符串` | 当前作业的 [`job_id`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id)。 |
|
||||
| `github.ref` | `字符串` | 触发工作流程的分支或标记参考。 对于分支，格式为 `refs/heads/<branch_name>`，对于标记是 `refs/tags/<tag_name>`。 |
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `github` | `object` | The top-level context available during any job or step in a workflow. |
|
||||
| `github.action` | `string` | The name of the action currently running. {% data variables.product.prodname_dotcom %} removes special characters or uses the name `__run` when the current step runs a script. If you use the same action more than once in the same job, the name will include a suffix with the sequence number with underscore before it. For example, the first script you run will have the name `__run`, and the second script will be named `__run_2`. Similarly, the second invocation of `actions/checkout` will be `actionscheckout2`. |
|
||||
| `github.action_path` | `string` | The path where your action is located. You can use this path to easily access files located in the same repository as your action. This attribute is only supported in composite actions. |
|
||||
| `github.actor` | `string` | The login of the user that initiated the workflow run. |
|
||||
| `github.base_ref` | `string` | The `base_ref` or target branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either `pull_request` or `pull_request_target`. |
|
||||
| `github.event` | `object` | The full event webhook payload. For more information, see "[Events that trigger workflows](/articles/events-that-trigger-workflows/)." You can access individual properties of the event using this context. |
|
||||
| `github.event_name` | `string` | The name of the event that triggered the workflow run. |
|
||||
| `github.event_path` | `string` | The path to the full event webhook payload on the runner. |
|
||||
| `github.head_ref` | `string` | The `head_ref` or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either `pull_request` or `pull_request_target`. |
|
||||
| `github.job` | `string` | The [`job_id`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. |
|
||||
| `github.ref` | `string` | The branch or tag ref that triggered the workflow run. For branches this is the format `refs/heads/<branch_name>`, and for tags it is `refs/tags/<tag_name>`. |
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %}
|
||||
| `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} | | `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} | | `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %}
|
||||
| `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} |
|
||||
| `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} |
|
||||
| `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %} |
|
||||
{%- endif %}
|
||||
| `github.repository` | `string` | The owner and repository name. 例如 `Codertocat/Hello-World`。 | | `github.repository_owner` | `string` | The repository owner's name. 例如 `Codertocat`。 | | `github.run_id` | `string` | {% data reusables.github-actions.run_id_description %} | | `github.run_number` | `string` | {% data reusables.github-actions.run_number_description %} | | `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. | | `github.server_url` | `string` | Returns the URL of the GitHub server. 例如：`https://github.com`。 | | `github.sha` | `string` | The commit SHA that triggered the workflow run. | | `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. 这在功能上等同于 `GITHUB_TOKEN` 密码。 更多信息请参阅“[使用 GITHUB_TOKEN 验证身份](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)”。 | | `github.workflow` | `string` | The name of the workflow. 如果工作流程文件未指定 `name`，此属性的值将是仓库中工作流程文件的完整路径。 | | `github.workspace` | `string` | The default working directory for steps and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. |
|
||||
| `github.repository` | `string` | The owner and repository name. For example, `Codertocat/Hello-World`. |
|
||||
| `github.repository_owner` | `string` | The repository owner's name. For example, `Codertocat`. |
|
||||
| `github.run_id` | `string` | {% data reusables.github-actions.run_id_description %} |
|
||||
| `github.run_number` | `string` | {% data reusables.github-actions.run_number_description %} |
|
||||
| `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. |
|
||||
| `github.server_url` | `string` | Returns the URL of the GitHub server. For example: `https://github.com`. |
|
||||
| `github.sha` | `string` | The commit SHA that triggered the workflow run. |
|
||||
| `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. This is functionally equivalent to the `GITHUB_TOKEN` secret. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." |
|
||||
| `github.workflow` | `string` | The name of the workflow. If the workflow file doesn't specify a `name`, the value of this property is the full path of the workflow file in the repository. |
|
||||
| `github.workspace` | `string` | The default working directory for steps and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. |
|
||||
|
||||
### `env` 上下文
|
||||
### `env` context
|
||||
|
||||
`env` 上下文包含已在工作流程、作业或步骤中设置的环境变量。 有关在工作流程中设置环境变量的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env)”。
|
||||
The `env` context contains environment variables that have been set in a workflow, job, or step. For more information about setting environment variables in your workflow, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env)."
|
||||
|
||||
`env` 上下文语法允许您在工作流程文件中使用环境变量的值。 您可以在**步骤**的任何键值中使用 `env` 上下文，但 `id` 和 `uses` 键除外。 有关步骤语法的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps)”。
|
||||
The `env` context syntax allows you to use the value of an environment variable in your workflow file. You can use the `env` context in the value of any key in a **step** except for the `id` and `uses` keys. For more information on the step syntax, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps)."
|
||||
|
||||
如果您想要在运行器中使用环境变量的值，请使用运行器操作系统的正常方法来读取环境变量。
|
||||
If you want to use the value of an environment variable inside a runner, use the runner operating system's normal method for reading environment variables.
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| ---------------------- | ----- | -------------------------------------- |
|
||||
| `env` | `对象` | 此上下文针对作业中的每个步骤而改变。 您可以从作业中的任何步骤访问此上下文。 |
|
||||
| `env.<env_name>` | `字符串` | 特定环境变量的值。 |
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `env` | `object` | This context changes for each step in a job. You can access this context from any step in a job. |
|
||||
| `env.<env_name>` | `string` | The value of a specific environment variable. |
|
||||
|
||||
### `job` 上下文
|
||||
### `job` context
|
||||
|
||||
`job` 上下文包含当前正在运行的作业相关信息。
|
||||
The `job` context contains information about the currently running job.
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| ----------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `job` | `对象` | 此上下文针对工作流程运行中的每项作业而改变。 您可以从作业中的任何步骤访问此上下文。 |
|
||||
| `job.container` | `对象` | 作业的容器相关信息。 有关容器的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/articles/workflow-syntax-for-github-actions#jobsjob_idcontainer)”。 |
|
||||
| `job.container.id` | `字符串` | 容器的 id。 |
|
||||
| `job.container.network` | `字符串` | 容器网络的 id。 运行程序创建作业中所有容器使用的网络。 |
|
||||
| `job.services` | `对象` | 为作业创建的服务容器。 有关服务容器的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/articles/workflow-syntax-for-github-actions#jobsjob_idservices)”。 |
|
||||
| `job.services.<service id>.id` | `字符串` | 服务容器的 id。 |
|
||||
| `job.services.<service id>.network` | `字符串` | 服务容器网络的 id。 运行程序创建作业中所有容器使用的网络。 |
|
||||
| `job.services.<service id>.ports` | `对象` | 服务容器显露的端口。 |
|
||||
| `job.status` | `字符串` | 作业的当前状态。 可能的值包括 `success`、`failure` 或 `cancelled`。 |
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `job` | `object` | This context changes for each job in a workflow run. You can access this context from any step in a job. |
|
||||
| `job.container` | `object` | Information about the job's container. For more information about containers, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions#jobsjob_idcontainer)." |
|
||||
| `job.container.id` | `string` | The id of the container. |
|
||||
| `job.container.network` | `string` | The id of the container network. The runner creates the network used by all containers in a job. |
|
||||
| `job.services` | `object` | The service containers created for a job. For more information about service containers, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions#jobsjob_idservices)." |
|
||||
| `job.services.<service id>.id` | `string` | The id of the service container. |
|
||||
| `job.services.<service id>.network` | `string` | The id of the service container network. The runner creates the network used by all containers in a job. |
|
||||
| `job.services.<service id>.ports` | `object` | The exposed ports of the service container. |
|
||||
| `job.status` | `string` | The current status of the job. Possible values are `success`, `failure`, or `cancelled`. |
|
||||
|
||||
### `steps` 上下文
|
||||
### `steps` context
|
||||
|
||||
`steps` 上下文包含当前作业中已经运行的步骤相关信息。
|
||||
The `steps` context contains information about the steps in the current job that have already run.
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| --------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `steps` | `对象` | 此上下文针对作业中的每个步骤而改变。 您可以从作业中的任何步骤访问此上下文。 |
|
||||
| `steps.<step id>.outputs` | `对象` | 为步骤定义的输出集。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的元数据语法](/articles/metadata-syntax-for-github-actions#outputs)”。 |
|
||||
| `steps.<step id>.conclusion` | `字符串` | 在 [`continue-on-error`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error) 应用之后完成的步骤的结果。 可能的值包括 `success`、`failure`、`cancelled` 或 `skipped`。 当 `continue-on-error` 步骤失败时，`outcome` 为 `failure`，但最终的 `conclusion` 为 `success`。 |
|
||||
| `steps.<step id>.outcome` | `字符串` | 在 [`continue-on-error`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error) 应用之前完成的步骤的结果。 可能的值包括 `success`、`failure`、`cancelled` 或 `skipped`。 当 `continue-on-error` 步骤失败时，`outcome` 为 `failure`，但最终的 `conclusion` 为 `success`。 |
|
||||
| `steps.<step id>.outputs.<output name>` | `字符串` | 特定输出的值。 |
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `steps` | `object` | This context changes for each step in a job. You can access this context from any step in a job. |
|
||||
| `steps.<step id>.outputs` | `object` | The set of outputs defined for the step. For more information, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions#outputs)." |
|
||||
| `steps.<step id>.conclusion` | `string` | The result of a completed step after [`continue-on-error`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error) is applied. Possible values are `success`, `failure`, `cancelled`, or `skipped`. When a `continue-on-error` step fails, the `outcome` is `failure`, but the final `conclusion` is `success`. |
|
||||
| `steps.<step id>.outcome` | `string` | The result of a completed step before [`continue-on-error`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error) is applied. Possible values are `success`, `failure`, `cancelled`, or `skipped`. When a `continue-on-error` step fails, the `outcome` is `failure`, but the final `conclusion` is `success`. |
|
||||
| `steps.<step id>.outputs.<output name>` | `string` | The value of a specific output. |
|
||||
|
||||
### `runner` 上下文
|
||||
### `runner` context
|
||||
|
||||
`runner` 上下文包含正在执行当前作业的运行器相关信息。
|
||||
The `runner` context contains information about the runner that is executing the current job.
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| ------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `runner.name` | `字符串` | {% data reusables.actions.runner-name-description %}
|
||||
| `runner.os` | `字符串` | {% data reusables.actions.runner-os-description %}
|
||||
| `runner.temp` | `字符串` | {% data reusables.actions.runner-temp-directory-description %}
|
||||
| `runner.tool_cache` | `字符串` | {% ifversion ghae %}有关如何确定 {% data variables.actions.hosted_runner %} 已安装所需软件的说明，请参阅“[创建自定义映像](/actions/using-github-hosted-runners/creating-custom-images)”。 {% else %} {% data reusables.actions.runner-tool-cache-description %} {% endif %}
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `runner.name` | `string` | {% data reusables.actions.runner-name-description %} |
|
||||
| `runner.os` | `string` | {% data reusables.actions.runner-os-description %} |{% if actions-runner-arch-envvars %}
|
||||
| `runner.arch` | `string` | {% data reusables.actions.runner-arch-description %} |{% endif %}
|
||||
| `runner.temp` | `string` | {% data reusables.actions.runner-temp-directory-description %} |
|
||||
| `runner.tool_cache` | `string` | {% ifversion ghae %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." {% else %} {% data reusables.actions.runner-tool-cache-description %} {% endif %}|
|
||||
|
||||
### `needs` 上下文
|
||||
### `needs` context
|
||||
|
||||
`needs` 上下文包含定义为当前作业依赖项的所有作业的输出。 有关定义作业依赖项的更多信息，请参阅“[{% data variables.product.prodname_actions %} 的工作流程语法](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)”。
|
||||
The `needs` context contains outputs from all jobs that are defined as a dependency of the current job. For more information on defining job dependencies, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)."
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| -------------------------------------------------- | ----- | ----------------------------------------------------------------- |
|
||||
| `needs.<job id>` | `对象` | 当前作业依赖的单个作业。 |
|
||||
| `needs.<job id>.outputs` | `对象` | 当前作业依赖的作业的输出集。 |
|
||||
| `needs.<job id>.outputs.<output name>` | `字符串` | 当前作业依赖的作业的特定输出值。 |
|
||||
| `needs.<job id>.result` | `字符串` | 当前作业依赖的作业的结果。 可能的值包括 `success`、`failure`、`cancelled` 或 `skipped`。 |
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `needs.<job id>` | `object` | A single job that the current job depends on. |
|
||||
| `needs.<job id>.outputs` | `object` | The set of outputs of a job that the current job depends on. |
|
||||
| `needs.<job id>.outputs.<output name>` | `string` | The value of a specific output for a job that the current job depends on. |
|
||||
| `needs.<job id>.result` | `string` | The result of a job that the current job depends on. Possible values are `success`, `failure`, `cancelled`, or `skipped`. |
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
|
||||
### `inputs` context
|
||||
@@ -150,15 +162,15 @@ The `inputs` context contains information about the inputs of reusable workflow.
|
||||
|
||||
For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)".
|
||||
|
||||
| 属性名称 | 类型 | 描述 |
|
||||
| --------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `inputs` | `对象` | This context is only available when it is [a reusable workflow](/actions/learn-github-actions/reusing-workflows). |
|
||||
| `inputs.<name>` | `string` or `number` or `boolean` | Each input value passed from an external workflow. |
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `inputs` | `object` | This context is only available when it is [a reusable workflow](/actions/learn-github-actions/reusing-workflows). |
|
||||
| `inputs.<name>` | `string` or `number` or `boolean` | Each input value passed from an external workflow. |
|
||||
{% endif %}
|
||||
|
||||
#### 打印上下文信息到日志文件的示例
|
||||
#### Example printing context information to the log file
|
||||
|
||||
要检查每个上下文中可访问的信息，您可以使用此工作流程文件示例。
|
||||
To inspect the information that is accessible in each context, you can use this workflow file example.
|
||||
|
||||
{% data reusables.github-actions.github-context-warning %}
|
||||
|
||||
@@ -198,34 +210,37 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
## 上下文可用性
|
||||
## Context availability
|
||||
|
||||
在整个工作流程运行过程中，提供不同的上下文。 例如，`secrets` 上下文只能用于作业中的某些地方。
|
||||
Different contexts are available throughout a workflow run. For example, the `secrets` context may only be used at certain places within a job.
|
||||
|
||||
此外，某些功能只能在某些地方使用。 例如， `hashFiles` 函数无法随处可用。
|
||||
In addition, some functions may only be used in certain places. For example, the `hashFiles` function is not available everywhere.
|
||||
|
||||
下表列出了工作流程中每一个上下文和特殊函数可以使用的地方。 除非下面列出，否则可以在任何地方使用函数。 |{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
| 路径 | 上下文 | 特殊函数 |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| <code>concurrency</code> | <code>github</code> | |
|
||||
| <code>env</code> | <code>github, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.concurrency</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.container</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.container.credentials</code> | <code>github, needs, strategy, matrix, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.container.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.continue-on-error</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.defaults.run</code> | <code>github, needs, strategy, matrix, env, inputs</code> | |
|
||||
| <code>jobs.<job_id>.env</code> | <code>github, needs, strategy, matrix, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.environment</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.environment.url</code> | <code>github, needs, strategy, matrix, job, runner, env, steps, inputs</code> | |
|
||||
The following table indicates where each context and special function can be used within a workflow. Unless listed below, a function can be used anywhere.
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
|
||||
|
||||
| Path | Context | Special functions |
|
||||
| ---- | ------- | ----------------- |
|
||||
| <code>concurrency</code> | <code>github</code> | |
|
||||
| <code>env</code> | <code>github, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.concurrency</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.container</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.container.credentials</code> | <code>github, needs, strategy, matrix, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.container.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.continue-on-error</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.defaults.run</code> | <code>github, needs, strategy, matrix, env, inputs</code> | |
|
||||
| <code>jobs.<job_id>.env</code> | <code>github, needs, strategy, matrix, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.environment</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.environment.url</code> | <code>github, needs, strategy, matrix, job, runner, env, steps, inputs</code> | |
|
||||
| <code>jobs.<job_id>.if</code> | <code>github, needs, inputs</code> | <code>always, cancelled, success, failure</code> |
|
||||
| <code>jobs.<job_id>.name</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.outputs.<output_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs</code> | |
|
||||
| <code>jobs.<job_id>.runs-on</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.secrets.<secrets_id></code> | <code>github, needs, secrets</code> | |
|
||||
| <code>jobs.<job_id>.services</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.credentials</code> | <code>github, needs, strategy, matrix, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.name</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.outputs.<output_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs</code> | |
|
||||
| <code>jobs.<job_id>.runs-on</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.secrets.<secrets_id></code> | <code>github, needs, secrets</code> | |
|
||||
| <code>jobs.<job_id>.services</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.credentials</code> | <code>github, needs, strategy, matrix, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, inputs</code> | |
|
||||
| <code>jobs.<job_id>.steps.continue-on-error</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.env</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.if</code> | <code>github, needs, strategy, matrix, job, runner, env, steps, inputs</code> | <code>always, cancelled, success, failure, hashFiles</code> |
|
||||
@@ -234,32 +249,32 @@ jobs:
|
||||
| <code>jobs.<job_id>.steps.timeout-minutes</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.with</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.working-directory</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.strategy</code> | <code>github, needs, inputs</code> | |
|
||||
| <code>jobs.<job_id>.timeout-minutes</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.with.<with_id></code> | <code>github, needs</code> | |
|
||||
| <code>on.workflow_call.inputs.<inputs_id>.default</code> | <code>github</code> | |
|
||||
| <code>on.workflow_call.outputs.<output_id>.value</code> | <code>github, jobs, inputs</code> | |
|
||||
| <code>jobs.<job_id>.strategy</code> | <code>github, needs, inputs</code> | |
|
||||
| <code>jobs.<job_id>.timeout-minutes</code> | <code>github, needs, strategy, matrix, inputs</code> | |
|
||||
| <code>jobs.<job_id>.with.<with_id></code> | <code>github, needs</code> | |
|
||||
| <code>on.workflow_call.inputs.<inputs_id>.default</code> | <code>github</code> | |
|
||||
| <code>on.workflow_call.outputs.<output_id>.value</code> | <code>github, jobs, inputs</code> | |
|
||||
{% else %}
|
||||
| 路径 | 上下文 | 特殊函数 |
|
||||
| --------------------------- | --------------------------- | --------------------------- |
|
||||
| <code>concurrency</code> | <code>github</code> | |
|
||||
| <code>env</code> | <code>github, secrets</code> | |
|
||||
| <code>jobs.<job_id>.concurrency</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.container</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.container.credentials</code> | <code>github, needs, strategy, matrix, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.container.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.continue-on-error</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.defaults.run</code> | <code>github, needs, strategy, matrix, env</code> | |
|
||||
| <code>jobs.<job_id>.env</code> | <code>github, needs, strategy, matrix, secrets</code> | |
|
||||
| <code>jobs.<job_id>.environment</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.environment.url</code> | <code>github, needs, strategy, matrix, job, runner, env, steps</code> | |
|
||||
| <code>jobs.<job_id>.if</code> | <code>github, needs</code> | <code>always, cancelled, success, failure</code> |
|
||||
| <code>jobs.<job_id>.name</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.outputs.<output_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | |
|
||||
| <code>jobs.<job_id>.runs-on</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.services</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.credentials</code> | <code>github, needs, strategy, matrix, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets</code> | |
|
||||
| Path | Context | Special functions |
|
||||
| ---- | ------- | ----------------- |
|
||||
| <code>concurrency</code> | <code>github</code> | |
|
||||
| <code>env</code> | <code>github, secrets</code> | |
|
||||
| <code>jobs.<job_id>.concurrency</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.container</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.container.credentials</code> | <code>github, needs, strategy, matrix, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.container.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.continue-on-error</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.defaults.run</code> | <code>github, needs, strategy, matrix, env</code> | |
|
||||
| <code>jobs.<job_id>.env</code> | <code>github, needs, strategy, matrix, secrets</code> | |
|
||||
| <code>jobs.<job_id>.environment</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.environment.url</code> | <code>github, needs, strategy, matrix, job, runner, env, steps</code> | |
|
||||
| <code>jobs.<job_id>.if</code> | <code>github, needs</code> | <code>always, cancelled, success, failure</code> |
|
||||
| <code>jobs.<job_id>.name</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.outputs.<output_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | |
|
||||
| <code>jobs.<job_id>.runs-on</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.services</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.credentials</code> | <code>github, needs, strategy, matrix, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.services.<service_id>.env.<env_id></code> | <code>github, needs, strategy, matrix, job, runner, env, secrets</code> | |
|
||||
| <code>jobs.<job_id>.steps.continue-on-error</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.env</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.if</code> | <code>github, needs, strategy, matrix, job, runner, env, steps</code> | <code>always, cancelled, success, failure, hashFiles</code> |
|
||||
@@ -268,6 +283,6 @@ jobs:
|
||||
| <code>jobs.<job_id>.steps.timeout-minutes</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.with</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.steps.working-directory</code> | <code>github, needs, strategy, matrix, job, runner, env, secrets, steps</code> | <code>hashFiles</code> |
|
||||
| <code>jobs.<job_id>.strategy</code> | <code>github, needs</code> | |
|
||||
| <code>jobs.<job_id>.timeout-minutes</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
{% endif %}
|
||||
| <code>jobs.<job_id>.strategy</code> | <code>github, needs</code> | |
|
||||
| <code>jobs.<job_id>.timeout-minutes</code> | <code>github, needs, strategy, matrix</code> | |
|
||||
{% endif %}
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 环境变量
|
||||
intro: '{% data variables.product.prodname_dotcom %} 为每个 {% data variables.product.prodname_actions %} 工作流程运行设置默认环境变量。 您也可以在工作流程文件中设置自定义环境变量。'
|
||||
title: Environment variables
|
||||
intro: '{% data variables.product.prodname_dotcom %} sets default environment variables for each {% data variables.product.prodname_actions %} workflow run. You can also set custom environment variables in your workflow file.'
|
||||
redirect_from:
|
||||
- /github/automating-your-workflow-with-github-actions/using-environment-variables
|
||||
- /actions/automating-your-workflow-with-github-actions/using-environment-variables
|
||||
@@ -17,11 +17,11 @@ versions:
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
{% data reusables.actions.ae-beta %}
|
||||
|
||||
## 关于环境变量
|
||||
## About environment variables
|
||||
|
||||
{% data variables.product.prodname_dotcom %} 设置适用于工作流程运行中每个步骤的默认环境变量。 环境变量区分大小写。 在操作或步骤中运行的命令可以创建、读取和修改环境变量。
|
||||
{% data variables.product.prodname_dotcom %} sets default environment variables that are available to every step in a workflow run. Environment variables are case-sensitive. Commands run in actions or steps can create, read, and modify environment variables.
|
||||
|
||||
要设置自定义环境变量，您需要在工作流程文件中指定变量。 您可以使用 [`jobs.<job_id>.steps[*].env`](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv)、[`jobs.<job_id>.env`](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idenv) 和 [`env`](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env) 关键字定义步骤、作业或整个工作流程的环境变量。 更多信息请参阅“[{% data variables.product.prodname_dotcom %} 的工作流程语法](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepsenv)”。
|
||||
To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the [`jobs.<job_id>.steps[*].env`](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv), [`jobs.<job_id>.env`](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idenv), and [`env`](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env) keywords. For more information, see "[Workflow syntax for {% data variables.product.prodname_dotcom %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepsenv)."
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@@ -41,51 +41,61 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
要在工作流程文件中使用环境变量的值，您应该使用 [`env` 上下文](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)。 如果要在运行器中使用环境变量的值，您可以使用运行器操作系统的正常方法来读取环境变量。
|
||||
To use the value of an environment variable in a workflow file, you should use the [`env` context](/actions/reference/context-and-expression-syntax-for-github-actions#env-context). If you want to use the value of an environment variable inside a runner, you can use the runner operating system's normal method for reading environment variables.
|
||||
|
||||
如果使用工作流程文件的 `run` 键从运行器操作系统中读取环境变量（如上例所示），则在作业发送到运行器后，该变量将在运行器操作系统中被替换。 对于工作流程文件的其他部分，必须使用 `env` 上下文来读取环境变量；这是因为工作流程键（例如 `if`）需要在发送到运行器之前，在工作流程处理过程中替换变量。
|
||||
If you use the workflow file's `run` key to read environment variables from within the runner operating system (as shown in the example above), the variable is substituted in the runner operating system after the job is sent to the runner. For other parts of a workflow file, you must use the `env` context to read environment variables; this is because workflow keys (such as `if`) require the variable to be substituted during workflow processing before it is sent to the runner.
|
||||
|
||||
You can also use the `GITHUB_ENV` environment file to set an environment variable that the following steps in a job can use. The environment file can be used directly by an action or as a shell command in a workflow file using the `run` keyword. 更多信息请参阅“[{% data variables.product.prodname_actions %} 的工作流程命令](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)”。
|
||||
You can also use the `GITHUB_ENV` environment file to set an environment variable that the following steps in a job can use. The environment file can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)."
|
||||
|
||||
## 默认环境变量
|
||||
## Default environment variables
|
||||
|
||||
强烈建议操作使用环境变量访问文件系统，而非使用硬编码的文件路径。 {% data variables.product.prodname_dotcom %} 设置供操作用于所有运行器环境中的环境变量。
|
||||
We strongly recommend that actions use environment variables to access the filesystem rather than using hardcoded file paths. {% data variables.product.prodname_dotcom %} sets environment variables for actions to use in all runner environments.
|
||||
|
||||
| 环境变量 | 描述 |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `CI` | 始终设置为 `true`。 |
|
||||
| `GITHUB_WORKFLOW` | 工作流程的名称。 |
|
||||
| `GITHUB_RUN_ID` | {% data reusables.github-actions.run_id_description %}
|
||||
| `GITHUB_RUN_NUMBER` | {% data reusables.github-actions.run_number_description %}
|
||||
| `GITHUB_JOB` | 当前作业的 [job_id](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id)。 |
|
||||
| `GITHUB_ACTION` | 操作唯一的标识符 (`id`)。 |
|
||||
| `GITHUB_ACTION_PATH` | 您的操作所在的路径。 您可以使用此路径访问与操作位于同一仓库中的文件。 此变量仅在复合操作中才受支持。 |
|
||||
| `GITHUB_ACTIONS` | 当 {% data variables.product.prodname_actions %} 运行工作流程时，始终设置为 `true`。 您可以使用此变量来区分测试是在本地运行还是通过 {% data variables.product.prodname_actions %} 运行。 |
|
||||
| `GITHUB_ACTOR` | 发起工作流程的个人或应用程序的名称。 例如 `octocat`。 |
|
||||
| `GITHUB_REPOSITORY` | 所有者和仓库名称。 例如 `octocat/Hello-World`。 |
|
||||
| `GITHUB_EVENT_NAME` | 触发工作流程的 web 挂钩事件的名称。 |
|
||||
| `GITHUB_EVENT_PATH` | 具有完整 web 挂钩事件有效负载的文件路径。 例如 `/github/workflow/event.json`。 |
|
||||
| `GITHUB_WORKSPACE` | {% data variables.product.prodname_dotcom %} 工作空间目录路径，初始为空白。 例如 `/home/runner/work/my-repo-name/my-repo-name`。 [actions/checkout](https://github.com/actions/checkout) 操作将在此目录内检出文件，默认情况下是仓库的副本。 |
|
||||
| `GITHUB_SHA` | 触发工作流程的提交 SHA。 例如 `ffac537e6cbbf934b08745a378932722df287a53`。 |
|
||||
| `GITHUB_REF` | 触发工作流程的分支或标记参考。 例如 `refs/heads/feature-branch-1`。 如果分支或标记都不适用于事件类型，则变量不会存在。 |
|
||||
| Environment variable | Description |
|
||||
| ---------------------|------------ |
|
||||
| `CI` | Always set to `true`. |
|
||||
| `GITHUB_WORKFLOW` | The name of the workflow. |
|
||||
| `GITHUB_RUN_ID` | {% data reusables.github-actions.run_id_description %} |
|
||||
| `GITHUB_RUN_NUMBER` | {% data reusables.github-actions.run_number_description %} |
|
||||
| `GITHUB_JOB` | The [job_id](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. |
|
||||
| `GITHUB_ACTION` | The unique identifier (`id`) of the action. |
|
||||
| `GITHUB_ACTION_PATH` | The path where your action is located. You can use this path to access files located in the same repository as your action. This variable is only supported in composite actions. |
|
||||
| `GITHUB_ACTIONS` | Always set to `true` when {% data variables.product.prodname_actions %} is running the workflow. You can use this variable to differentiate when tests are being run locally or by {% data variables.product.prodname_actions %}.
|
||||
| `GITHUB_ACTOR` | The name of the person or app that initiated the workflow. For example, `octocat`. |
|
||||
| `GITHUB_REPOSITORY` | The owner and repository name. For example, `octocat/Hello-World`. |
|
||||
| `GITHUB_EVENT_NAME` | The name of the webhook event that triggered the workflow. |
|
||||
| `GITHUB_EVENT_PATH` | The path of the file with the complete webhook event payload. For example, `/github/workflow/event.json`. |
|
||||
| `GITHUB_WORKSPACE` | The {% data variables.product.prodname_dotcom %} workspace directory path, initially empty. For example, `/home/runner/work/my-repo-name/my-repo-name`. The [actions/checkout](https://github.com/actions/checkout) action will check out files, by default a copy of your repository, within this directory. |
|
||||
| `GITHUB_SHA` | The commit SHA that triggered the workflow. For example, `ffac537e6cbbf934b08745a378932722df287a53`. |
|
||||
| `GITHUB_REF` | The branch or tag ref that triggered the workflow. For example, `refs/heads/feature-branch-1`. If neither a branch or tag is available for the event type, the variable will not exist. |
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %}
|
||||
| `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} | | `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} | | `GITHUB_REF_TYPE` | {% data reusables.actions.ref_type-description %}
|
||||
| `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} |
|
||||
| `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} |
|
||||
| `GITHUB_REF_TYPE` | {% data reusables.actions.ref_type-description %} |
|
||||
{%- endif %}
|
||||
| `GITHUB_HEAD_REF` | Only set for pull request events. 头部分支的名称。 | `GITHUB_BASE_REF` | Only set for pull request events. 基础分支的名称。 | `GITHUB_SERVER_URL`| Returns the URL of the {% data variables.product.product_name %} server. 例如： `https://{% data variables.product.product_url %}`。 | `GITHUB_API_URL` | Returns the API URL. 例如： `{% data variables.product.api_url_code %}`。 | `GITHUB_GRAPHQL_URL` | Returns the GraphQL API URL. 例如： `{% data variables.product.graphql_url_code %}`。 | `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} | `RUNNER_OS` | {% data reusables.actions.runner-os-description %} | `RUNNER_TEMP` | {% data reusables.actions.runner-temp-directory-description %}
|
||||
| `GITHUB_HEAD_REF` | Only set for pull request events. The name of the head branch.
|
||||
| `GITHUB_BASE_REF` | Only set for pull request events. The name of the base branch.
|
||||
| `GITHUB_SERVER_URL`| Returns the URL of the {% data variables.product.product_name %} server. For example: `https://{% data variables.product.product_url %}`.
|
||||
| `GITHUB_API_URL` | Returns the API URL. For example: `{% data variables.product.api_url_code %}`.
|
||||
| `GITHUB_GRAPHQL_URL` | Returns the GraphQL API URL. For example: `{% data variables.product.graphql_url_code %}`.
|
||||
| `RUNNER_NAME` | {% data reusables.actions.runner-name-description %}
|
||||
| `RUNNER_OS` | {% data reusables.actions.runner-os-description %}{% if actions-runner-arch-envvars %}
|
||||
| `RUNNER_ARCH` | {% data reusables.actions.runner-arch-description %}{% endif %}
|
||||
| `RUNNER_TEMP` | {% data reusables.actions.runner-temp-directory-description %}
|
||||
{% ifversion not ghae %}| `RUNNER_TOOL_CACHE` | {% data reusables.actions.runner-tool-cache-description %}{% endif %}
|
||||
|
||||
{% tip %}
|
||||
|
||||
**注：**如果需要在作业中使用工作流程运行的 URL，您可以组合这些环境变量：`$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID`
|
||||
**Note:** If you need to use a workflow run's URL from within a job, you can combine these environment variables: `$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID`
|
||||
|
||||
{% endtip %}
|
||||
|
||||
### 确定何时使用默认环境变量或上下文
|
||||
### Determining when to use default environment variables or contexts
|
||||
|
||||
{% data reusables.github-actions.using-context-or-environment-variables %}
|
||||
|
||||
## 环境变量命名约定
|
||||
## Naming conventions for environment variables
|
||||
|
||||
设置自定义环境变量时，不能使用上面列出的前缀为 `GITHUB_` 的任何默认环境变量名称。 如果尝试重写其中一个默认环境变量的值，则会忽略赋值。
|
||||
When you set a custom environment variable, you cannot use any of the default environment variable names listed above with the prefix `GITHUB_`. If you attempt to override the value of one of these default environment variables, the assignment is ignored.
|
||||
|
||||
您设置的指向文件系统上某个位置的任何新环境变量都应该有 `_PATH` 后缀。 `HOME` 和 `GITHUB_WORKSPACE` 默认变量例外于此约定，因为 "home" 和 "workspace" 一词已经暗示位置。
|
||||
Any new environment variables you set that point to a location on the filesystem should have a `_PATH` suffix. The `HOME` and `GITHUB_WORKSPACE` default variables are exceptions to this convention because the words "home" and "workspace" already imply a location.
|
||||
|
||||
@@ -54,6 +54,36 @@ It's not possible to add CPU or memory resources to an existing AWS/EC2 instance
|
||||
3. Start the instance.
|
||||
{% data reusables.enterprise_installation.configuration-recognized %}
|
||||
|
||||
## Adding CPU or memory resources on Microsoft Azure
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** To add CPU or memory resources in Microsoft Azure, you must be familiar with using either the Azure Portal, Azure CLI or Azure Powershell to manage VM instances. For background and details on using the Azure tools of your choice to perform the resize, please refer to the Azure documentation on [changing the size of a virtual machine](https://docs.microsoft.com/en-us/azure/virtual-machines/resize-vm).
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Resizing considerations
|
||||
|
||||
Before increasing CPU or memory resources for {% data variables.product.product_location %}, review the following recommendations.
|
||||
|
||||
- **Scale your memory with CPUs**. {% data reusables.enterprise_installation.increasing-cpus-req %}
|
||||
- **Assign a static IP address to the instance**. If you haven't assigned a static IP to your instance, you might have to adjust the DNS A records for your {% data variables.product.prodname_ghe_server %} host after the restart to account for the change in IP address.
|
||||
|
||||
### Supported Microsoft Azure instance sizes
|
||||
|
||||
You need to determine the instance size you would like to upgrade to based on CPU/memory specifications.
|
||||
|
||||
{% data reusables.enterprise_installation.warning-on-scaling %}
|
||||
|
||||
{% data reusables.enterprise_installation.azure-instance-recommendation %}
|
||||
|
||||
### Resizing for Microsoft Azure
|
||||
|
||||
You can scale the VM up by changing the VM size. Changing its size will cause it to be restarted. In some cases, you must deallocate the VM first. This can happen if the new size is not available on the hardware cluster that is currently hosting the VM.
|
||||
|
||||
1. Refer to the Azure documentation on [changing the size of a virtual machine](https://docs.microsoft.com/en-us/azure/virtual-machines/resize-vm) for the required steps.
|
||||
{% data reusables.enterprise_installation.configuration-recognized %}
|
||||
|
||||
## Adding CPU or memory resources for OpenStack KVM
|
||||
|
||||
It's not possible to add CPU or memory resources to an existing OpenStack KVM instance. Instead, you must:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 在 Azure 上安装 GitHub Enterprise Server
|
||||
intro: '要在 Azure 上安装 {% data variables.product.prodname_ghe_server %}，您必须部署到 DS 系列实例上并使用 Premium-LRS 存储。'
|
||||
title: Installing GitHub Enterprise Server on Azure
|
||||
intro: 'To install {% data variables.product.prodname_ghe_server %} on Azure, you must deploy onto a DS-series instance and use Premium-LRS storage.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/installation/installing-github-enterprise-on-azure/
|
||||
- /enterprise/admin/installation/installing-github-enterprise-server-on-azure
|
||||
@@ -13,63 +13,58 @@ topics:
|
||||
- Enterprise
|
||||
- Infrastructure
|
||||
- Set up
|
||||
shortTitle: 在 Azure 上安装
|
||||
shortTitle: Install on Azure
|
||||
---
|
||||
You can deploy {% data variables.product.prodname_ghe_server %} on global Azure or Azure Government.
|
||||
|
||||
您可以将 {% data variables.product.prodname_ghe_server %} 部署在全局 Azure 或 Azure Government 上。
|
||||
|
||||
## 基本要求
|
||||
## Prerequisites
|
||||
|
||||
- {% data reusables.enterprise_installation.software-license %}
|
||||
- 您必须具有能够配置新机器的 Azure 帐户。 更多信息请参阅 [Microsoft Azure 网站](https://azure.microsoft.com)。
|
||||
- 启动虚拟机 (VM) 所需的大部分操作也可以使用 Azure Portal 执行。 不过，我们建议安装 Azure 命令行接口 (CLI) 进行初始设置。 下文介绍了使用 Azure CLI 2.0 的示例。 更多信息请参阅 Azure 指南“[安装 Azure CLI 2.0](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest)”。
|
||||
- You must have an Azure account capable of provisioning new machines. For more information, see the [Microsoft Azure website](https://azure.microsoft.com).
|
||||
- Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide "[Install Azure CLI 2.0](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest)."
|
||||
|
||||
## 硬件考量因素
|
||||
## Hardware considerations
|
||||
|
||||
{% data reusables.enterprise_installation.hardware-considerations-all-platforms %}
|
||||
|
||||
## 确定虚拟机类型
|
||||
## Determining the virtual machine type
|
||||
|
||||
在 Azure 上启动 {% data variables.product.product_location %} 之前，您需要确定最符合您的组织需求的设备类型。 要查看 {% data variables.product.product_name %} 的最低要求，请参阅“[最低要求](#minimum-requirements)”。
|
||||
Before launching {% data variables.product.product_location %} on Azure, you'll need to determine the machine type that best fits the needs of your organization. To review the minimum requirements for {% data variables.product.product_name %}, see "[Minimum requirements](#minimum-requirements)."
|
||||
|
||||
{% data reusables.enterprise_installation.warning-on-scaling %}
|
||||
|
||||
{% data variables.product.prodname_ghe_server %} 设备需要高级存储数据磁盘，可以在支持高级存储的任何 Azure VM 上使用。 带有 `` 后缀的 Azure VM 类型支持高级存储。 更多信息请参阅 Azure 文档中的“[Azure 中有哪些磁盘类型？](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd)”和“[Azure 高级存储：高性能设计](https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance)”。
|
||||
{% data reusables.enterprise_installation.azure-instance-recommendation %}
|
||||
|
||||
{% data variables.product.company_short %} 建议对 {% data variables.product.prodname_ghe_server %} 使用内存优化的虚拟机。 更多信息请参阅 Azure 文档中的“[内存优化的虚拟机大小](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes-memory)”。
|
||||
|
||||
{% data variables.product.prodname_ghe_server %} 可以在支持您的 VM 类型的任何地区使用。 有关各个 VM 的支持地区的更多信息，请参阅 Azure 的“[可用产品（按地区）](https://azure.microsoft.com/regions/services/)”。
|
||||
|
||||
## 创建 {% data variables.product.prodname_ghe_server %} 虚拟机
|
||||
## Creating the {% data variables.product.prodname_ghe_server %} virtual machine
|
||||
|
||||
{% data reusables.enterprise_installation.create-ghe-instance %}
|
||||
|
||||
1. 找到最新的 {% data variables.product.prodname_ghe_server %} 设备映像。 更多关于 `vm image list` 命令的信息，请参阅 Microsoft 文档中的“[az vm image list](https://docs.microsoft.com/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_list)”。
|
||||
1. Find the most recent {% data variables.product.prodname_ghe_server %} appliance image. For more information about the `vm image list` command, see "[az vm image list](https://docs.microsoft.com/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_list)" in the Microsoft documentation.
|
||||
```shell
|
||||
$ az vm image list --all -f GitHub-Enterprise | grep '"urn":' | sort -V
|
||||
```
|
||||
|
||||
2. 使用找到的设备映像创建新的 VM。 更多信息请参阅 Microsoft 文档中的“[az vm 创建](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_create)”。
|
||||
2. Create a new VM using the appliance image you found. For more information, see "[az vm create](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation.
|
||||
|
||||
传入以下选项：VM 名称、资源组、VM 大小、首选 Azure 地区名称、上一步中列出的设备映像 VM 的名称，以及用于高级存储的存储 SKU。 更多关于资源组的信息，请参阅 Microsoft 文档中的“[资源组](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-overview#resource-groups)”。
|
||||
Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation.
|
||||
|
||||
```shell
|
||||
$ az vm create -n <em>VM_NAME</em> -g <em>RESOURCE_GROUP</em> --size <em>VM_SIZE</em> -l <em>REGION</em> --image <em>APPLIANCE_IMAGE_NAME</em> --storage-sku Premium_LRS
|
||||
```
|
||||
|
||||
3. 在 VM 上配置安全设置，以打开所需端口。 更多信息请参阅 Microsoft 文档中的 "[az vm open-port](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)"。 请参阅下表中对每个端口的说明，以确定需要打开的端口。
|
||||
3. Configure the security settings on your VM to open up required ports. For more information, see "[az vm open-port](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.
|
||||
|
||||
```shell
|
||||
$ az vm open-port -n <em>VM_NAME</em> -g <em>RESOURCE_GROUP</em> --port <em>PORT_NUMBER</em>
|
||||
```
|
||||
|
||||
此表列出了每个端口的用途。
|
||||
This table identifies what each port is used for.
|
||||
|
||||
{% data reusables.enterprise_installation.necessary_ports %}
|
||||
|
||||
4. 创建新的未加密数据磁盘并将其附加至 VM，然后根据用户许可数配置大小。 更多信息请参阅 Microsoft 文档中的“[az vm 磁盘附加](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)”。
|
||||
4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
|
||||
|
||||
传入以下选项：VM 名称（例如 `ghe-acme-corp`）、资源组、高级存储 SKU、磁盘大小（例如 `100`）以及生成的 VHD 的名称。
|
||||
Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD.
|
||||
|
||||
```shell
|
||||
$ az vm disk attach --vm-name <em>VM_NAME</em> -g <em>RESOURCE_GROUP</em> --sku Premium_LRS --new -z <em>SIZE_IN_GB</em> --name ghe-data.vhd --caching ReadWrite
|
||||
@@ -77,33 +72,33 @@ shortTitle: 在 Azure 上安装
|
||||
|
||||
{% note %}
|
||||
|
||||
**注：**为确保非生产实例具有足够的 I/O 通量，建议最小磁盘容量为 40 GiB 并启用读/写缓存 (`--caching ReadWrite`)。
|
||||
**Note:** For non-production instances to have sufficient I/O throughput, the recommended minimum disk size is 40 GiB with read/write cache enabled (`--caching ReadWrite`).
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## 配置 {% data variables.product.prodname_ghe_server %} 虚拟机
|
||||
## Configuring the {% data variables.product.prodname_ghe_server %} virtual machine
|
||||
|
||||
1. 在配置 VM 之前，您必须等待其进入 ReadyRole 状态。 使用 `vm list` 命令检查 VM 的状态。 更多信息请参阅 Microsoft 文档中的“[az vm 列表](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_list)”。
|
||||
1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the `vm list` command. For more information, see "[az vm list](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_list)" in the Microsoft documentation.
|
||||
```shell
|
||||
$ az vm list -d -g <em>RESOURCE_GROUP</em> -o table
|
||||
> Name ResourceGroup PowerState PublicIps Fqdns Location Zones
|
||||
> ------ --------------- ------------ ------------ ------- ---------- -------
|
||||
> VM_NAME RESOURCE_GROUP VM running 40.76.79.202 eastus
|
||||
|
||||
|
||||
```
|
||||
{% note %}
|
||||
|
||||
**注**：Azure 不会自动为 VM 创建 FQDNS 条目。 更多信息请参阅 Azure 指南中关于如何“[在 Azure 门户中为 Linux VM 创建完全限定域名](https://docs.microsoft.com/azure/virtual-machines/linux/portal-create-fqdn)”的说明。
|
||||
|
||||
|
||||
**Note:** Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "[Create a fully qualified domain name in the Azure portal for a Linux VM](https://docs.microsoft.com/azure/virtual-machines/linux/portal-create-fqdn)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
||||
{% data reusables.enterprise_installation.copy-the-vm-public-dns-name %}
|
||||
{% data reusables.enterprise_installation.upload-a-license-file %}
|
||||
{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} 更多信息请参阅“[配置 {% data variables.product.prodname_ghe_server %} 设备](/enterprise/admin/guides/installation/configuring-the-github-enterprise-server-appliance)”。
|
||||
{% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} For more information, see "[Configuring the {% data variables.product.prodname_ghe_server %} appliance](/enterprise/admin/guides/installation/configuring-the-github-enterprise-server-appliance)."
|
||||
{% data reusables.enterprise_installation.instance-will-restart-automatically %}
|
||||
{% data reusables.enterprise_installation.visit-your-instance %}
|
||||
|
||||
## 延伸阅读
|
||||
|
||||
- "[系统概述](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[关于升级到新版本](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[System overview](/enterprise/admin/guides/installation/system-overview)"{% ifversion ghes %}
|
||||
- "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)"{% endif %}
|
||||
|
||||
@@ -14,6 +14,7 @@ children:
|
||||
- /changing-the-machine-type-for-your-codespace
|
||||
- /setting-your-default-editor-for-codespaces
|
||||
- /setting-your-default-region-for-codespaces
|
||||
- /setting-your-timeout-period-for-codespaces
|
||||
- /prebuilding-codespaces-for-your-project
|
||||
---
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ shortTitle: Personalize your codespaces
|
||||
When using any development environment, customizing the settings and tools to your preferences and workflows is an important step. {% data variables.product.prodname_codespaces %} allows for two main ways of personalizing your codespaces.
|
||||
|
||||
- [Settings Sync](#settings-sync) - You can use and share {% data variables.product.prodname_vscode %} settings between {% data variables.product.prodname_codespaces %} and other instances of {% data variables.product.prodname_vscode %}.
|
||||
- [Dotfiles](#dotfiles) – You can use a public `dotfiles` repository to specify scripts, shell preferences, and other configurations.
|
||||
- [Dotfiles](#dotfiles) – You can use a `dotfiles` repository to specify scripts, shell preferences, and other configurations.
|
||||
|
||||
{% data variables.product.prodname_codespaces %} personalization applies to any codespace you create.
|
||||
|
||||
@@ -33,7 +33,7 @@ Project maintainers can also define a default configuration that applies to ever
|
||||
|
||||
Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}.
|
||||
|
||||
To enable Settings Sync, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**. From the dialog, select which settings you'd like to sync.
|
||||
To enable Settings Sync, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**. In the dialog box, select the settings you'd like to sync.
|
||||
|
||||
|
||||
|
||||
@@ -41,13 +41,13 @@ For more information, see the [Settings Sync guide](https://code.visualstudio.co
|
||||
|
||||
## Dotfiles
|
||||
|
||||
Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your `dotfiles` repository, see [GitHub does dotfiles](https://dotfiles.github.io/).
|
||||
Dotfiles are files and folders on Unix-like systems starting with `.` that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your dotfiles repository, see [GitHub does dotfiles](https://dotfiles.github.io/).
|
||||
|
||||
If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named `dotfiles`, {% data variables.product.prodname_dotcom %} can automatically use this repository to personalize your codespace environment, once enabled from your [personal Codespaces settings](https://github.com/settings/codespaces). Private `dotfiles` repositories are not currently supported.
|
||||
Your dotfiles repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make.
|
||||
|
||||
Your `dotfiles` repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make.
|
||||
You can configure {% data variables.product.prodname_codespaces %} to use dotfiles from any repository you own by selecting that repository in your [personal {% data variables.product.prodname_codespaces %} settings](https://github.com/settings/codespaces).
|
||||
|
||||
When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your `dotfiles` repository to the codespace environment, and looks for one of the following files to set up the environment.
|
||||
When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your selected repository to the codespace environment, and looks for one of the following files to set up the environment.
|
||||
|
||||
* _install.sh_
|
||||
* _install_
|
||||
@@ -58,9 +58,9 @@ When you create a new codespace, {% data variables.product.prodname_dotcom %} cl
|
||||
* _setup_
|
||||
* _script/setup_
|
||||
|
||||
If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory.
|
||||
If none of these files are found, then any files or folders in your selected dotfiles repository starting with `.` are symlinked to the codespace's `~` or `$HOME` directory.
|
||||
|
||||
Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace.
|
||||
Any changes to your selected dotfiles repository will apply only to each new codespace, and do not affect any existing codespace.
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -70,18 +70,20 @@ Any changes to your `dotfiles` repository will apply only to each new codespace,
|
||||
|
||||
### Enabling your dotfiles repository for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
You can use your public `dotfiles` repository to personalize your {% data variables.product.prodname_codespaces %} environment. Once you set up that repository, you can add your scripts, preferences, and configurations to it. You then need to enable your dotfiles from your personal {% data variables.product.prodname_codespaces %} settings page.
|
||||
You can use your selected dotfiles repository to personalize your {% data variables.product.prodname_codespaces %} environment. Once you choose your dotfiles repository, you can add your scripts, preferences, and configurations to it. You then need to enable your dotfiles from your personal {% data variables.product.prodname_codespaces %} settings page.
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** Dotfiles have the ability to run arbitrary scripts, which may contain unexpected or malicious code. Before installing a dotfiles repo, we recommend checking scripts to ensure they don't perform any unexpected actions.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create.
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** This option is only available if you've created a public `dotfiles` repository for your user account.
|
||||
|
||||
{% endnote %}
|
||||
1. Under "Dotfiles", select **Automatically install dotfiles** so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create.
|
||||
|
||||
2. Choose the repository you want to install dotfiles from.
|
||||
|
||||
|
||||
You can add further script, preferences, configuration files to your dotfiles repository or edit existing files whenever you want. Changes to settings will only be picked up by new codespaces.
|
||||
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Setting your timeout period for Codespaces
|
||||
intro: 'You can set your default timeout for {% data variables.product.prodname_codespaces %} in your personal settings page.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Set the timeout
|
||||
---
|
||||
|
||||
A codespace will stop running after a period of inactivity. You can specify the length of this timeout period. The updated setting will apply to any newly created codespace.
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning**: Codespaces are billed per minute. If you are not actively using a codespace but the codespace has not yet timed out, you are still billed for the time that the codespace is running. For more information, see "[About billing for Codespaces](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)."
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
## Setting your default timeout
|
||||
|
||||
{% include tool-switcher %}
|
||||
|
||||
{% webui %}
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Default idle timeout", enter the time that you want, then click **Save**. The time must be between 5 minutes and 240 minutes (4 hours).
|
||||
|
||||
|
||||
{% endwebui %}
|
||||
|
||||
{% cli %}
|
||||
|
||||
{% data reusables.cli.cli-learn-more %}
|
||||
|
||||
To set the timeout period, use the `idle-timeout` argument with the `codespace create` subcommand. Specify the time in minutes, followed by `m`. The time must be between 5 minutes and 240 minutes (5 hours).
|
||||
|
||||
```shell
|
||||
gh codespace create --idle-timeout 90m
|
||||
```
|
||||
|
||||
If you do not specify a timeout period when creating a codespace, then your default timeout period will be used. You cannot currently specify a default timeout period for all future codespaces through {% data variables.product.prodname_cli %}.
|
||||
|
||||
{% endcli %}
|
||||
@@ -15,13 +15,13 @@ product: '{% data reusables.gated-features.codespaces %}'
|
||||
|
||||
The lifecycle of a codespace begins when you create a codespace and ends when you delete it. You can disconnect and reconnect to an active codespace without affecting its running processes. You may stop and restart a codespace without losing changes that you have made to your project.
|
||||
|
||||
## 创建代码空间
|
||||
## Creating a codespace
|
||||
|
||||
When you want to work on a project, you can choose to create a new codespace or open an existing codespace. You might want to create a new codespace from a branch of your project each time you develop in {% data variables.product.prodname_codespaces %} or keep a long-running codespace for a feature.
|
||||
|
||||
If you choose to create a new codespace each time you work on a project, you should regularly push your changes so that any new commits are on {% data variables.product.prodname_dotcom %}. You can have up to 10 codespaces at a time. Once you have 10 codespaces, you must delete a codespace before you can create a new one. 更多信息请参阅“[创建代码空间](/codespaces/developing-in-codespaces/creating-a-codespace)”。
|
||||
If you choose to create a new codespace each time you work on a project, you should regularly push your changes so that any new commits are on {% data variables.product.prodname_dotcom %}. You can have up to 10 codespaces at a time. Once you have 10 codespaces, you must delete a codespace before you can create a new one. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)."
|
||||
|
||||
If you choose to use a long-running codespace for your project, you should pull from your repository's default branch each time you start working in your codespace so that your environment has the latest commits. This workflow is very similar to if you were working with a project on your local machine.
|
||||
If you choose to use a long-running codespace for your project, you should pull from your repository's default branch each time you start working in your codespace so that your environment has the latest commits. This workflow is very similar to if you were working with a project on your local machine.
|
||||
|
||||
## Saving changes in a codespace
|
||||
|
||||
@@ -33,11 +33,11 @@ If you have unsaved changes, your editor will prompt you to save them before exi
|
||||
|
||||
## Codespaces timeouts
|
||||
|
||||
If you leave your codespace running without interaction or if you exit your codespace without explicitly stopping it, the codespace will timeout after 30 minutes of inactivity and stop running. For more information, see "[Stopping a codespace](#stopping-a-codespace)."
|
||||
If you leave your codespace running without interaction, or if you exit your codespace without explicitly stopping it, the codespace will timeout after a period of inactivity and stop running. By default, a codespace will timeout after 30 minutes of inactivity, but you can customize the duration of the timeout period for new codespaces that you create. For more information about setting the default timeout period for your codespaces, see "[Setting your timeout period for Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-codespaces)." For more information about stopping a codespace, see "[Stopping a codespace](#stopping-a-codespace)."
|
||||
|
||||
When a codespace times out, your data is preserved from the last time your changes were saved. For more information, see "[Saving changes in a codespace](#saving-changes-in-a-codespace)."
|
||||
|
||||
## 重建代码空间
|
||||
## Rebuilding a codespace
|
||||
|
||||
You can rebuild your codespace to restore a clean state as if you had created a new codespace. For most uses, you can create a new codespace as an alternative to rebuilding a codespace. You are most likely to rebuild a codespace to implement changes to your dev container. When you rebuild a codespace, any Docker containers, images, volumes, and caches are cleaned, then the codespace is rebuilt.
|
||||
|
||||
@@ -63,9 +63,9 @@ You can stop a codespace at any time. When you stop a codespace, any running pro
|
||||
|
||||
Only running codespaces incur CPU charges; a stopped codespace incurs only storage costs.
|
||||
|
||||
You may want to stop and restart a codespace to apply changes to it. For example, if you change the machine type used for your codespace, you will need to stop and restart it for the change to take effect. You can also stop your codespace and choose to restart or delete it if you encounter an error or something unexpected. 更多信息请参阅“[暂停或停止代码空间](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#suspending-or-stopping-a-codespace)”。
|
||||
You may want to stop and restart a codespace to apply changes to it. For example, if you change the machine type used for your codespace, you will need to stop and restart it for the change to take effect. You can also stop your codespace and choose to restart or delete it if you encounter an error or something unexpected. For more information, see "[Suspending or stopping a codespace](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#suspending-or-stopping-a-codespace)."
|
||||
|
||||
## 删除代码空间
|
||||
## Deleting a codespace
|
||||
|
||||
You can create a codespace for a particular task and then safely delete the codespace after you push your changes to a remote branch.
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
#Reference: #5727
|
||||
#Documentation for new runner 'arch' environment variables set by the `runner` app.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.4'
|
||||
ghae: 'ghae-issue-5727'
|
||||
@@ -122,6 +122,10 @@ sections:
|
||||
|
||||
For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#auditing-github-actions-events)."
|
||||
- Performance improvements have been made to {% data variables.product.prodname_actions %}, which may result in higher maximum job concurrency.
|
||||
-
|
||||
heading: 'GitHub Packages changes'
|
||||
notes:
|
||||
- When a repository is deleted, any associated package files are now immediately deleted from your {% data variables.product.prodname_registry %} external storage.
|
||||
-
|
||||
heading: 'Dependabot and Dependency graph changes'
|
||||
notes:
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
The architecture of the runner executing the job. Possible values are `X86`, `X64`, `ARM`, and `ARM64`.
|
||||
@@ -0,0 +1,5 @@
|
||||
{% data variables.product.prodname_ghe_server %} 设备需要高级存储数据磁盘，可以在支持高级存储的任何 Azure VM 上使用。 带有 `` 后缀的 Azure VM 类型支持高级存储。 更多信息请参阅 Azure 文档中的“[Azure 中有哪些磁盘类型？](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd)”和“[Azure 高级存储：高性能设计](https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance)”。
|
||||
|
||||
{% data variables.product.company_short %} 建议对 {% data variables.product.prodname_ghe_server %} 使用内存优化的虚拟机。 更多信息请参阅 Azure 文档中的“[内存优化的虚拟机大小](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes-memory)”。
|
||||
|
||||
{% data variables.product.prodname_ghe_server %} 可以在支持您的 VM 类型的任何地区使用。 有关各个 VM 的支持地区的更多信息，请参阅 Azure 的“[可用产品（按地区）](https://azure.microsoft.com/regions/services/)”。
|
||||
Reference in New Issue
Block a user