text stringlengths 12 91.7k | metadata dict |
|---|---|
About converting your personal account
Converting a personal account into an organization allows you move to a shared account where a large number of people can collaborate across many projects at once. Converting your account:
Preserves the repositories as they are without the need to transfer them to another account... | {
"source": "github-docs/account-and-profile/concepts/account-management.md",
"title": "Personal account management"
} |
About your contribution graph
Your profile contributions graph is a record of contributions you've made to repositories on . Contributions are timestamped according to Coordinated Universal Time (UTC) rather than your local time zone.
If you are part of an organization that uses SAML single sign-on (SSO), you won’t be ... | {
"source": "github-docs/account-and-profile/concepts/contributions-on-your-profile.md",
"title": "Contributions on your profile"
} |
Adding an email address to your account
allows you to add as many email addresses to your account as you like. For more information, see AUTOTITLE.
If you set an email address in your local Git configuration, you will need to add it to your account settings in order to connect your commits to your account. For more i... | {
"source": "github-docs/account-and-profile/concepts/email-addresses.md",
"title": "Email addresses"
} |
An organization owner can invite you to join their organization as a member, billing manager, or owner. An organization owner or member with admin privileges for a repository can invite you to collaborate in one or more repositories as an outside collaborator. For more information, see AUTOTITLE.
You can access organiz... | {
"source": "github-docs/account-and-profile/concepts/organization-membership.md",
"title": "About organization membership"
} |
You can customize your organization's profile by adding any of the following:
A description
A location
A website
An email address
You can also pin important repositories and add a README.md file to help orient visitors. For more information, see AUTOTITLE.
Organizations that use can confirm their organization's id... | {
"source": "github-docs/account-and-profile/concepts/organization-profile.md",
"title": "Your organization's profile"
} |
Your profile showcases your work, contributions, and information you choose to share publicly.
Key profile elements
Your profile includes these customizable elements:
Profile README: A customizable section at the top of your profile
Personal info: Profile picture, name, pronouns, and bio
Contribution activity: Vis... | {
"source": "github-docs/account-and-profile/concepts/personal-profile.md",
"title": "About your profile"
} |
About username changes
You can change your username to another username that is not currently in use. If the username you want is not available, consider other names or unique variations. Using a number, hyphen, or an alternative spelling might help you find a similar username that's still available.
After changing you... | {
"source": "github-docs/account-and-profile/concepts/username-changes.md",
"title": "Username changes"
} |
About your account
Your account is the foundation of your identity. It controls your access to repositories, organizations, and features, and manages your personal settings and preferences.
About
If you're a member of an , your account is a . are provisioned and managed by your enterprise through your identity pr... | {
"source": "github-docs/account-and-profile/get-started/account.md",
"title": "Account"
} |
Accessing your personal dashboard
Your personal dashboard is the first page you'll see when you sign in on .
To access your personal dashboard once you're signed in, click the in the upper-left corner of any page.
Finding your recent activity
In the "Recent activity" section of your news feed, you can quickly find an... | {
"source": "github-docs/account-and-profile/get-started/personal-dashboard-quickstart.md",
"title": "Quickstart for your personal dashboard"
} |
About your profile
Your profile is how other people discover and learn about you on . You can customize your profile to highlight your best work and share more about yourself.
For a general tutorial on personalizing your profile, see AUTOTITLE.
For more specific profile customization, see AUTOTITLE.
For reference i... | {
"source": "github-docs/account-and-profile/get-started/profile.md",
"title": "Profile"
} |
Prerequisites
Before changing your username, you should be aware of potential impacts on your account and activity. For more information, see AUTOTITLE.
Changing your username
1. In the "Change username" section, click Change username.
1. Read the warnings about changing your username. If you still want to change your... | {
"source": "github-docs/account-and-profile/how-tos/account-management/changing-your-username.md",
"title": "Changing your username"
} |
Prerequisites
The personal account you want to convert cannot be a member of any organizations. If the personal account you want to convert is a member of an organization, you must leave the organization before you can convert the account.
You may not be able to convert a personal account into an organization if an ent... | {
"source": "github-docs/account-and-profile/how-tos/account-management/converting-a-user-into-an-organization.md",
"title": "Converting a user into an organization"
} |
About your personal account on
To get started with , you need to a personal account and a verified email address.
When creating a free account on , you can also authenticate with Google or Apple - which are the supported social login providers.
For iOS users, even if you have enabled the setting "Hide My Email address... | {
"source": "github-docs/account-and-profile/how-tos/account-management/creating-an-account-on-github.md",
"title": "Creating an account on GitHub"
} |
[!NOTE]
If your enterprise manages your account and you sign into through your company's identity provider (IdP), you cannot delete your account. For more information, see AUTOTITLE.
[!NOTE]
You should contact an enterprise owner before deleting your account on .
Back up your account data
Before you delete your p... | {
"source": "github-docs/account-and-profile/how-tos/account-management/deleting-your-personal-account.md",
"title": "Deleting your personal account"
} |
Contributing to multiple accounts using HTTPS and s
Alternatively, if you want to use the HTTPS protocol for both accounts, you can use different s for each account by configuring Git to store different credentials for each repository.
If the output is osxkeychain, you're using the macOS keychain. To clear the cred... | {
"source": "github-docs/account-and-profile/how-tos/account-management/managing-multiple-accounts.md",
"title": "Managing multiple accounts"
} |
[!TIP]
allow an enterprise to provision unique personal accounts for its members through an identity provider (IdP). For more information, see AUTOTITLE. For other use cases, we recommend using only one personal account to manage both personal and professional repositories.
[!TIP]
We recommend using only one person... | {
"source": "github-docs/account-and-profile/how-tos/account-management/merging-multiple-personal-accounts.md",
"title": "Merging multiple personal accounts"
} |
Keeping your username for the organization
If you want your new organization to use your current personal account username, you'll need to rename your personal account first:
1. Change your personal account username to something new. For more information, see AUTOTITLE.
1. Create an organization using your original use... | {
"source": "github-docs/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md",
"title": "Moving your work to an organization"
} |
[!WARNING]
Following these steps will not disable 2FA or provide access to a locked account, but will instead unlink the associated email address so it may be used for a different account. If you cannot regain access to the 2FA locked account, these steps will permanently break the link between the account and the lin... | {
"source": "github-docs/account-and-profile/how-tos/account-management/unlinking-your-email-address-from-a-locked-account.md",
"title": "Unlinking your email address from a locked account"
} |
1. Click Register a new application.
1. Under Application name, type "Jira".
1. Under Homepage URL, type the full URL to your Jira instance.
1. Under Authorization callback URL, type the full URL to your Jira instance.
1. Click Register application.
1. Under Developer applications, note the "Client ID" and "Client Secr... | {
"source": "github-docs/account-and-profile/how-tos/account-settings/integrating-jira-with-your-personal-projects.md",
"title": "Integrating Jira with your personal projects"
} |
Changing your cookie preferences
You can customize how non-essential cookies behave on any enterprise marketing page. For more information about how uses cookies, see AUTOTITLE.
1. Navigate to the enterprise marketing page where you'd like to change your cookie preferences. For example, navigate to Resources.
1. S... | {
"source": "github-docs/account-and-profile/how-tos/account-settings/manage-cookie-preferences.md",
"title": "Manage cookie preferences"
} |
[!NOTE] This article will help you customize your experience on the website as a whole. For information on using specific products with screen readers and other assistive technologies, see the Accessibility Documentation.
Managing the appearance of links
You can control whether links in text blocks are underlined a... | {
"source": "github-docs/account-and-profile/how-tos/account-settings/managing-accessibility-settings.md",
"title": "Managing accessibility settings"
} |
[!NOTE] This topic tells you how you can manage the security and analysis features for all your existing or new repositories. For information on managing these settings for individual repositories, see AUTOTITLE.
Enabling or disabling features for existing repositories
1. Under "", to the right of the feature, click D... | {
"source": "github-docs/account-and-profile/how-tos/account-settings/managing-security-and-analysis-features.md",
"title": "Managing security and analysis features"
} |
If you feel that tabbed indentation in code rendered on takes up too much, or too little space, you can change this in your settings.
1. In the left sidebar, click Appearance.
1. Scroll down to "Tab size preference" and use the dropdown menu to choose your preference.
Next steps
For reference information, see AUTOTI... | {
"source": "github-docs/account-and-profile/how-tos/account-settings/managing-your-tab-size-rendering-preference.md",
"title": "Managing your tab size rendering preference"
} |
Update your personal account information
1. Unverify your company email address by deleting it in your Email settings.
After removal, you can re-add this email without verifying to keep any associated commits linked to your account.
For more information, see AUTOTITLE.
1. Change your primary email address from yo... | {
"source": "github-docs/account-and-profile/how-tos/account-settings/prepare-for-job-change.md",
"title": "Prepare for job change"
} |
1. Under Jobs Profile, select Available for hire, then click Save jobs profile.
Next steps
For reference information, see AUTOTITLE. | {
"source": "github-docs/account-and-profile/how-tos/account-settings/set-your-hiring-status.md",
"title": "Set your hiring status"
} |
Changing the visibility of your private contributions
1. Above the contribution calendar, click Contribution settings.
!Screenshot of the "Contribution settings" link, highlighted with a dark orange outline.
1. Click Private contributions to show or hide private contributions on your profile.
Changing the visibilit... | {
"source": "github-docs/account-and-profile/how-tos/contribution-settings/manage-visibility-settings-for-private-contributions-and-achievements.md",
"title": "Manage visibility settings for private contributions {% ifversion hide-individual-achievements %}and achievements {% endif %}"
} |
[!IMPORTANT]
The connection between your accounts is governed by GitHub's Privacy Statement and users enabling the connection must agree to the GitHub Terms of Service.
Sending your enterprise contributions to your profile
Before you can connect your profile to your or profile, your enterprise owner must enable a... | {
"source": "github-docs/account-and-profile/how-tos/contribution-settings/sharing-contributions-from-github-enterprise-server.md",
"title": "Sharing contributions from GitHub Enterprise Server"
} |
Managing the visibility of the activity overview on your profile
1. Above your contributions graph, select the Contribution settings dropdown menu, then click Activity overview.
!Screenshot of the contributions graph on a user profile. A dropdown menu, labeled "Contribution settings", is highlighted with an orange o... | {
"source": "github-docs/account-and-profile/how-tos/contribution-settings/showing-an-overview-of-your-activity-on-your-profile.md",
"title": "Showing an overview of your activity on your profile"
} |
Commit was made less than 24 hours ago
After making a commit that meets the requirements to count as a contribution, you may need to wait for up to 24 hours to see the contribution appear on your contributions graph. For more information, see AUTOTITLE.
Your local Git commit email isn't connected to your account
Commi... | {
"source": "github-docs/account-and-profile/how-tos/contribution-settings/troubleshooting-missing-contributions.md",
"title": "Troubleshooting missing contributions"
} |
View commit details
1. In the "Contribution activity" section of your profile, click the number of commits next to a specific repository.
Finding missing commits in your timeline
If you can't find expected commits on your profile, the commit history may have been rewritten, creating different author and commit dates. ... | {
"source": "github-docs/account-and-profile/how-tos/contribution-settings/viewing-commit-details-from-your-timeline.md",
"title": "Viewing commit details from your timeline"
} |
Prerequisites
Before you view contributions on your profile, you should understand what counts as a contribution, and what other information your profile displays. See AUTOTITLE.
Viewing contributions in a specific time range
1. To see a visual representation of your contributions, scroll down to the section labeled "... | {
"source": "github-docs/account-and-profile/how-tos/contribution-settings/viewing-contributions-on-your-profile.md",
"title": "Viewing contributions on your profile"
} |
[!NOTE]
If you're a member of an , you cannot make changes to your email address on .
1. If you'd like to associate the email address with your web-based Git operations, select it from the "Primary email address" dropdown menu.
!Screenshot of the "Email" settings page. Under "Primary email address," a dropdown me... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/adding-an-email-address-to-your-github-account.md",
"title": "Adding an email address to your GitHub account"
} |
When you enable this setting, each time you push to , we’ll check the most recent commit. If the author email on that commit is a private email on your GitHub account, we will block the push and warn you about exposing your private email.
1. To keep your email address private in commits you push from the command line, ... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md",
"title": "Blocking command line pushes that expose your personal email address"
} |
[!NOTE] This article does not apply to . To change your email address as a , contact the administrator for your company's identity provider (IdP). Your primary email address is the first one assigned to you in the IdP.
1. If you'd like to add a new email address to set as your primary email address, under "Add email ad... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/changing-your-primary-email-address.md",
"title": "Changing your primary email address"
} |
users
1. In the GitHub Desktop menu, click Preferences.
1. In the Preferences window, verify the following:
To view your username, click Accounts.
To view your Git email, click Git. Note that this email is not guaranteed to be your primary email.
1. In the File menu, click Options.
1. In the Options window, ... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/remembering-your-github-username-or-email.md",
"title": "Remembering your GitHub username or email"
} |
1. Under "Backup email address," use the dropdown menu to select the address you want to set as your backup email address.
1. Click Save.
Next steps
For reference information, see AUTOTITLE. | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/setting-a-backup-email-address.md",
"title": "Setting a backup email address"
} |
Setting your commit email address on
Setting your commit email address in Git
You can use the git config command to change the email address you associate with your Git commits. The new email address you set will be visible in any future commits you push to from the command line. Any commits you made prior to changi... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address.md",
"title": "Setting your commit email address"
} |
Email already in use
If you see the error message Error adding EMAIL: email is already in use, it means the email address is already linked to another account. An email address can only be associated with one account at a time.
To use this email with a different account, follow these steps:
1. Sign in to the account ... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/troubleshooting-adding-an-email.md",
"title": "Troubleshooting adding an email"
} |
Unable to send verification email
Account is restricted until you change your email address
If your account is restricted and you're told to change the email address on your account before access can be restored, you must update your account email and then ask to review the restriction.
1. Add a different, non-dispos... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/troubleshooting-email-verification.md",
"title": "Troubleshooting email verification"
} |
Verifying your email address
1. Under your email address, click Resend verification email.
!Screenshot of email addresses on the "Emails" page. Under an email address, a link, labeled "Resend verification email," is outlined in orange.
1. will send you an email with a link in it. After you click that link, you'll b... | {
"source": "github-docs/account-and-profile/how-tos/email-preferences/verifying-your-email-address.md",
"title": "Verifying your email address"
} |
[!TIP]
Only organization owners can see and change the account settings for an organization. | {
"source": "github-docs/account-and-profile/how-tos/organization-membership/accessing-an-organization.md",
"title": "Accessing an organization"
} |
1. Locate your username in the list of members. If the list is large, you can search for your username in the search box.
1. Next to your username, select the visibility dropdown menu, then click a new visibility.
To publicize your membership, choose Public.
To hide your membership, choose Private.
!Screen... | {
"source": "github-docs/account-and-profile/how-tos/organization-membership/publicizing-or-hiding-organization-membership.md",
"title": "Publicizing or hiding organization membership"
} |
If your personal account is a member of an enterprise, you can leave the enterprise at any time.
After leaving an enterprise, you will no longer be a member of any organization in the enterprise, and you will lose licenses and other privileges granted through the enterprise.
[!NOTE] If you use a provided by your ent... | {
"source": "github-docs/account-and-profile/how-tos/organization-membership/removing-yourself-from-an-enterprise.md",
"title": "Removing yourself from an enterprise"
} |
[!WARNING]
If you're currently responsible for paying for in your organization, removing yourself from the organization does not update the billing information on file for the organization. If you are currently responsible for billing, you must have another owner or billing manager for the organization update the org... | {
"source": "github-docs/account-and-profile/how-tos/organization-membership/removing-yourself-from-an-organization.md",
"title": "Removing yourself from an organization"
} |
Prerequisites
Before you can request organization approval for an , you need to authorize it for your personal account. See AUTOTITLE.
Requesting organization approval for an
1. In the list of applications, click the name of the you'd like to request access for.
1. Next to the organization you'd like the to access,... | {
"source": "github-docs/account-and-profile/how-tos/organization-membership/requesting-organization-approval-for-oauth-apps.md",
"title": "Requesting organization approval for OAuth apps"
} |
Viewing organization roles
1. To filter the list by role, select the Role dropdown menu and click a role.
!Screenshot of the list of organization members. In the header of the list, a dropdown menu, labeled "Role," is outlined in dark orange.
If your organization uses , you can also view the enterprise owners who ma... | {
"source": "github-docs/account-and-profile/how-tos/organization-membership/viewing-peoples-roles-in-an-organization.md",
"title": "Viewing people's roles in an organization"
} |
Prerequisites
will display your profile README on your profile page if all of the following are true.
You've created a repository with a name that matches your username.
The repository is public.
The repository contains a file named README.md in its root.
The README.md file contains any content.
[!NOTE]
If you ... | {
"source": "github-docs/account-and-profile/how-tos/profile-customization/managing-your-profile-readme.md",
"title": "Managing your profile README"
} |
Pinning items to your profile
1. At the top of the "Popular repositories" or "Pinned" section, click Customize your pins.
!Screenshot of the "Pinned" section of a user profile. A link, labeled "Customize your pins", is highlighted with an orange outline.
1. Optionally, to change which items are included in the searc... | {
"source": "github-docs/account-and-profile/how-tos/profile-customization/pinning-items-to-your-profile.md",
"title": "Pinning items to your profile"
} |
Changing your profile's privacy settings
1. Navigate to the "Public profile" section, and scroll down to "Contributions & Activity"
1. Select the checkbox next to Make profile private and hide activity.
Next steps
For more information about private profiles, see AUTOTITLE.
For reference information, see AUTOTITLE. | {
"source": "github-docs/account-and-profile/how-tos/profile-customization/setting-your-profile-to-private.md",
"title": "Setting your profile to private"
} |
Email verification restrictions
Unverified email address restrictions
If you do not verify your email address, you cannot:
Create or fork repositories
Create issues or pull requests
Comment on issues, pull requests, or commits
Authorize applications
Generate s
Receive email notifications
Star repositories
Cre... | {
"source": "github-docs/account-and-profile/reference/email-addresses-reference.md",
"title": "Email addresses reference"
} |
Side effects of account deletion
All repositories, forks of private repositories, wikis, issues, pull requests and sites owned by your account will be deleted. Your billing will end immediately. Your username will be available for anyone to use after 90 days.
All repositories, forks of private repositories, wikis, ... | {
"source": "github-docs/account-and-profile/reference/personal-account-reference.md",
"title": "Personal account reference"
} |
Recent activity
In the "Recent activity" section of your dashboard, you can preview up to 4 updates made in the last two weeks.
Top repositories
Your list of top repositories is automatically generated, and can include any repository you have interacted with, whether it's owned directly by your account or not. Interac... | {
"source": "github-docs/account-and-profile/reference/personal-dashboard.md",
"title": "Personal dashboard"
} |
What counts as a contribution
Contributions are only counted if they meet certain criteria. In some cases, we may need to rebuild your graph in order for contributions to appear.
On your profile page, the following actions always count as contributions:
Creating a new repository
Forking an existing repository
The fol... | {
"source": "github-docs/account-and-profile/reference/profile-contributions-reference.md",
"title": "Profile contributions reference"
} |
Visibility of profile information
The name that is displayed on your profile may also be displayed next to comments you make on private repositories owned by an organization. For more information, see AUTOTITLE.
Links to your social accounts are visible to anyone who can view your profile.
Profile picture requirements... | {
"source": "github-docs/account-and-profile/reference/profile-reference.md",
"title": "Profile reference"
} |
Changing your username
The following list contains limitations and considerations when changing your username. For the username policy, see AUTOTITLE.
Limitations of username changes
Members of an cannot change usernames. Your enterprise's IdP administrator controls your username. For more information, see AUTOTIT... | {
"source": "github-docs/account-and-profile/reference/username-reference.md",
"title": "Username reference"
} |
[!NOTE]
Your profile name for your is account is required. All other profile information described in this article is optional.
Changing your profile picture
Your profile picture helps identify you across in pull requests, comments, contributions pages, and graphs.
Setting a profile picture
Resetting your profile... | {
"source": "github-docs/account-and-profile/tutorials/personalize-your-profile.md",
"title": "Personalize your profile"
} |
How can my profile help with my job search?
When you include a link to your profile in your resume, you showcase your skills and experience to potential employers. In this article, you'll find practical tips for preparing your profile for a job search.
After you complete these steps, you can be confident that hiring... | {
"source": "github-docs/account-and-profile/tutorials/using-your-github-profile-to-enhance-your-resume.md",
"title": "Using your GitHub profile to enhance your resume"
} |
About billing for
For more information, see AUTOTITLE.
usage is free for instances that use self-hosted runners. For more information, see AUTOTITLE.
Availability
is available on all products, but is not available for private repositories owned by accounts using legacy per-repository plans.
Usage limits and p... | {
"source": "github-docs/actions/concepts/billing-and-usage.md",
"title": "Billing and usage"
} |
About usage metrics
About performance metrics
Next steps
To learn how to find metrics for your organization or repository, see AUTOTITLE. | {
"source": "github-docs/actions/concepts/metrics.md",
"title": "About GitHub Actions metrics"
} |
About
The following diagram illustrates the architecture of ARC's autoscaling runner scale set mode.
[!NOTE]
To view the following diagram in a larger size, see the Autoscaling Runner Scale Sets mode documentation in the Actions Runner Controller repository.
<!-- The numbers in the ordered list below correspond to n... | {
"source": "github-docs/actions/concepts/runners/actions-runner-controller.md",
"title": "Actions Runner Controller"
} |
USER runner
Software installed in the ARC runner image
The ARC runner image is bundled with the following software:
Runner binaries
Runner container hooks
Docker (required for Docker-in-Docker mode)
For more information, see ARC's runner image Dockerfile in the Actions repository.
Assets and releases
ARC is releas... | {
"source": "github-docs/actions/concepts/runners/actions-runner-controller.md",
"title": "Actions Runner Controller"
} |
Overview of -hosted runners
Runners are the machines that execute jobs in a workflow. For example, a runner can clone your repository locally, install testing software, and then run commands that evaluate your code.
provides runners that you can use to run your jobs, or you can host your own runners.
Each runner com... | {
"source": "github-docs/actions/concepts/runners/github-hosted-runners.md",
"title": "GitHub-hosted runners"
} |
To learn about larger runners, see the documentation.
About
What you can do with larger runners
All support the following capabilities:
Runner groups: Organize runners and control which repositories can use them
Autoscaling: Scale runners up or down based on workload demand
Concurrency controls: Limit how many ... | {
"source": "github-docs/actions/concepts/runners/larger-runners.md",
"title": "Larger runners"
} |
About -hosted runners networking
There are a few different approaches you could take to configure this access, each with different advantages and disadvantages.
Using an API Gateway with OIDC
For more information, see AUTOTITLE.
Using WireGuard to create a network overlay
For more information, see AUTOTITLE.
Using... | {
"source": "github-docs/actions/concepts/runners/private-networking.md",
"title": "Private networking with GitHub-hosted runners"
} |
About runner groups
Runner groups help you enforce consistent access policies for runners across your infrastructure.
With runner groups, you can:
Organize and self-hosted runners
Restrict which organizations and repositories can use specific runners
Route jobs to a specific runner group in your workflow file
Set ... | {
"source": "github-docs/actions/concepts/runners/runner-groups.md",
"title": "Runner groups"
} |
About runner scale sets
A runner scale set is a group of homogeneous runners that can be assigned jobs from . The number of active runners owned by a runner scale set can be controlled by auto-scaling runner solutions such as (ARC).
You can use runner groups to manage runner scale sets. Similar to self-hosted runners,... | {
"source": "github-docs/actions/concepts/runners/runner-scale-sets.md",
"title": "Runner scale sets"
} |
A self-hosted runner is a system that you deploy and manage to execute jobs from on .
Self-hosted runners:
Give you more control of hardware, operating system, and software tools than -hosted runners provide. Be aware that you are responsible for updating the operating system and all other software.
Allow you to use... | {
"source": "github-docs/actions/concepts/runners/self-hosted-runners.md",
"title": "Self-hosted runners"
} |
Overview
The Actions Runner Controller (ARC) project was adopted by GitHub to release as a new GitHub product. As a result, there are currently two ARC releases: the legacy community-maintained ARC and GitHub's Autoscaling Runner Sets.
GitHub only supports the latest Autoscaling Runner Sets version of ARC. Support for ... | {
"source": "github-docs/actions/concepts/runners/support-for-arc.md",
"title": "Support for Actions Runner Controller"
} |
Overview
SLSA levels for artifact attestations
The SLSA framework is an industry standard used to evaluate supply chain security. It is organized into levels. Each level represents an increasing degree of security and trustworthiness for a software supply chain. Artifact attestations by itself provides SLSA v1.0 Build... | {
"source": "github-docs/actions/concepts/security/artifact-attestations.md",
"title": "Artifact attestations"
} |
Potential impact of a compromised runner
These sections consider some of the steps an attacker can take if they're able to run malicious commands on a runner.
[!NOTE]
-hosted runners do not scan for malicious code downloaded by a user during their job, such as a compromised third party library.
Accessing secrets
Wo... | {
"source": "github-docs/actions/concepts/security/compromised-runners.md",
"title": "Compromised runners"
} |
About the GITHUBTOKEN
At the start of each workflow job, automatically creates a unique GITHUBTOKEN secret to use in your workflow. You can use the GITHUBTOKEN to authenticate in the workflow job.
When you enable , installs a on your repository. The GITHUBTOKEN secret is a installation access token. You can use the... | {
"source": "github-docs/actions/concepts/security/github_token.md",
"title": "GITHUB_TOKEN"
} |
About Kubernetes admission controller
Artifact attestations enable you to create unfalsifiable provenance and integrity guarantees for the software you build. In turn, people who consume your software can verify where and how your software was built.
Kubernetes admission controllers are plugins that govern the behavior... | {
"source": "github-docs/actions/concepts/security/kubernetes-admissions-controller.md",
"title": "Kubernetes admissions controller"
} |
Overview of OpenID Connect (OIDC)
workflows are often designed to access a cloud provider (such as AWS, Azure, GCP, HashiCorp Vault, and others) in order to deploy software or use the cloud's services. Before the workflow can access these resources, it will supply credentials, such as a password or token, to the cloud... | {
"source": "github-docs/actions/concepts/security/openid-connect.md",
"title": "OpenID Connect"
} |
Understanding the risk of script injections
When creating workflows, custom actions, and composite actions, you should always consider whether your code might execute untrusted input from attackers. This can occur when an attacker adds malicious commands and scripts to a context. When your workflow runs, those strings ... | {
"source": "github-docs/actions/concepts/security/script-injections.md",
"title": "Script injections"
} |
About secrets
Secrets allow you to store sensitive information in your organization, repository, or repository environments. Secrets are variables that you create to use in workflows in an organization, repository, or repository environment.
can only read a secret if you explicitly include the secret in a workflow.
... | {
"source": "github-docs/actions/concepts/security/secrets.md",
"title": "Secrets"
} |
By default, allows multiple jobs within the same workflow, multiple workflow runs within the same repository, and multiple workflow runs across a repository owner's account to run concurrently. This means that multiple instances of the same workflow or job can run at the same time, performing the same steps.
also all... | {
"source": "github-docs/actions/concepts/workflows-and-actions/concurrency.md",
"title": "Concurrency"
} |
About contexts
Each context is an object that contains properties, which can be strings or other objects.
For example, the matrix context is only populated for jobs in a matrix.
You can access contexts using the expression syntax. For more information, see AUTOTITLE.
$
Determining when to use contexts
includes a co... | {
"source": "github-docs/actions/concepts/workflows-and-actions/contexts.md",
"title": "Contexts"
} |
About custom actions
You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with 's APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy productio... | {
"source": "github-docs/actions/concepts/workflows-and-actions/custom-actions.md",
"title": "About custom actions"
} |
About workflow dependency caching
Workflow runs often reuse the same outputs or downloaded dependencies from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies.
Jobs on -hosted runners start in a clean runner image... | {
"source": "github-docs/actions/concepts/workflows-and-actions/dependency-caching.md",
"title": "Dependency caching"
} |
Each job in a workflow can reference a single environment. Any protection rules configured for the environment must pass before a job referencing the environment is sent to a runner. The job can access the environment's secrets only after the job is sent to a runner.
When a workflow references an environment, the envir... | {
"source": "github-docs/actions/concepts/workflows-and-actions/deployment-environments.md",
"title": "Deployment environments"
} |
About expressions
You can use expressions to programmatically set environment variables in workflow files and access contexts. An expression can be any combination of literal values, references to a context, or functions. You can combine literals, context references, and functions using operators. For more information ... | {
"source": "github-docs/actions/concepts/workflows-and-actions/expressions.md",
"title": "Expressions"
} |
If you enable email or web notifications for , you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow... | {
"source": "github-docs/actions/concepts/workflows-and-actions/notifications-for-workflow-runs.md",
"title": "Notifications for workflow runs"
} |
Reusable workflows
Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow.
Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to... | {
"source": "github-docs/actions/concepts/workflows-and-actions/reusing-workflow-configurations.md",
"title": "Reusing workflow configurations"
} |
About
Variables provide a way to store and reuse non-sensitive configuration information. You can store any configuration data such as compiler flags, usernames, or server names as variables. Variables are interpolated on the runner machine that runs your workflow. Commands that run in actions or workflow steps can cre... | {
"source": "github-docs/actions/concepts/workflows-and-actions/variables.md",
"title": "Variables"
} |
About workflow artifacts
An artifact is a file or collection of files produced during a workflow run. Artifacts allow you to persist data after a job has completed, and share that data with another job in the same workflow. For example, you can use artifacts to save your build and test output after a workflow run has e... | {
"source": "github-docs/actions/concepts/workflows-and-actions/workflow-artifacts.md",
"title": "Workflow artifacts"
} |
About workflows
Workflow basics
A workflow must contain the following basic components:
1. One or more events that will trigger the workflow.
1. One or more jobs, each of which will execute on a runner machine and run a series of one or more steps.
1. Each step can either run a script that you define or run an action,... | {
"source": "github-docs/actions/concepts/workflows-and-actions/workflows.md",
"title": "Workflows"
} |
offers both and , each of which can be valuable automation and workflow tools. Understanding the differences and the benefits of each option will allow you to select the best fit for your job.
:
Run persistently and can react to events quickly.
Work great when persistent data is needed.
Work best with API requests ... | {
"source": "github-docs/actions/get-started/actions-vs-apps.md",
"title": "GitHub Actions vs GitHub Apps"
} |
About continuous deployment
Continuous deployment (CD) is the practice of using automation to publish and deploy software updates. As part of the typical CD process, the code is automatically built and tested before deployment.
Continuous deployment is often coupled with continuous integration. For more information abo... | {
"source": "github-docs/actions/get-started/continuous-deployment.md",
"title": "Continuous deployment"
} |
About continuous integration
Continuous integration (CI) is a software practice that requires frequently committing code to a shared repository. Committing code more often detects errors sooner and reduces the amount of code a developer needs to debug when finding the source of an error. Frequent code updates also make... | {
"source": "github-docs/actions/get-started/continuous-integration.md",
"title": "Continuous integration"
} |
Introduction
You can create workflows that run tests whenever you push a change to your repository, or that deploy merged pull requests to production.
This quickstart guide shows you how to use the user interface of to add a workflow that demonstrates some of the essential features of .
For an overview of workflows,... | {
"source": "github-docs/actions/get-started/quickstart.md",
"title": "Quickstart for GitHub Actions"
} |
Overview
You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production.
goes beyond just DevOps and lets you run workflows when other events happen in your repository. For example, you can run a workflow to automatically add the appropriate labels whe... | {
"source": "github-docs/actions/get-started/understand-github-actions.md",
"title": "Understanding GitHub Actions"
} |
Overview
If you use , members of your enterprise can create workflows that use actions directly from or .
searches your enterprise on for each action before falling back to . This ensures that custom versions of actions in your enterprise are used in preference to their counterparts on .
To ensure workflows use the... | {
"source": "github-docs/actions/how-tos/administer/reuse-namespaces-on-ghecom.md",
"title": "Making retired namespaces available on GHE.com"
} |
Viewing metrics for your organization
Viewing metrics for your repository
Understanding metrics aggregation | {
"source": "github-docs/actions/how-tos/administer/view-metrics.md",
"title": "Viewing GitHub Actions metrics"
} |
Introduction
You can write an action to provide a way for users to access your servers via a configured CLI environment on runners.
Your action should:
Make it simple for users to specify the version of the CLI to install
Support multiple operating systems
Run in an efficient fashion to minimize run-time and associ... | {
"source": "github-docs/actions/how-tos/create-and-publish-actions/create-a-cli-action.md",
"title": "Creating a third party CLI action"
} |
Choosing a location for your action
If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software.
Storing an action in its own repos... | {
"source": "github-docs/actions/how-tos/create-and-publish-actions/manage-custom-actions.md",
"title": "Managing custom actions"
} |
Prerequisites
[!NOTE]
You must accept the terms of service to publish actions in .
Before you can publish an action, you'll need to create an action in your repository. For more information, see AUTOTITLE.
When you plan to publish your action to , you'll need to ensure that the repository only includes the metadata fi... | {
"source": "github-docs/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md",
"title": "Publishing actions in GitHub Marketplace"
} |
Introduction
After you create an action, you'll want to continue releasing new features while working with community contributions. This tutorial describes an example process you can follow to release and maintain actions in open source. The example:
Leverages for continuous integration, dependency updates, release m... | {
"source": "github-docs/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md",
"title": "Releasing and maintaining actions"
} |
About exit codes
uses the exit code to set the action's check run status, which can be success or failure.
Exit status Check run status Description
------------------------------------------
0 success The action completed successfully and other tasks that depend on it can begin.
Nonzero value (any integer but 0) f... | {
"source": "github-docs/actions/how-tos/create-and-publish-actions/set-exit-codes.md",
"title": "Setting exit codes for actions"
} |
If you enable immutable releases on your action's repository, you can manage your action's releases as follows:
1. To start the release cycle, develop and validate a potential release for your action on a release branch.
1. Determine how you want to share your changes:
If you are ready to share an unchangeable vers... | {
"source": "github-docs/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md",
"title": "Using immutable releases and tags to manage your action's releases"
} |
About custom deployment protection rules
Custom deployment protection rules are powered by . Once a deployment protection rule is configured and installed in a repository, it can be enabled for any environments in the repository.
After you enable a custom deployment protection rule on an environment, every time a workf... | {
"source": "github-docs/actions/how-tos/deploy/configure-and-manage-deployments/configure-custom-protection-rules.md",
"title": "Configuring custom deployment protection rules"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.