зеркало из https://github.com/github/docs.git
Apps docs audit round 2 (#37352)
Co-authored-by: Jess Hosman <1183847+jhosman@users.noreply.github.com>
This commit is contained in:
Sarah Edwards
GitHub
Родитель
4e4c41f3bc
Коммит
46325c29e3
|
|
@ -58,3 +58,10 @@ To remove a published action from {% data variables.product.prodname_marketplace
|
|||
{% data reusables.releases.edit-release %}
|
||||
4. Select **Publish this action to the {% data variables.product.prodname_marketplace %}** to remove the check from the box.
|
||||
5. Click **Update release** at the bottom of the page.
|
||||
|
||||
## About badges in {% data variables.product.prodname_marketplace %}
|
||||
|
||||
Actions with the {% octicon "verified" aria-label="The verified badge" %}, or verified creator badge, indicate that {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. Partners can email <a href="mailto:partnerships@github.com">partnerships@github.com</a> to request the verified creator badge.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -750,3 +750,7 @@ This tutorial generates a user access token and saves it in a local file. You sh
|
|||
Depending on your device, you may choose different way to store the token. You should check the best practices for storing tokens on your device.
|
||||
|
||||
For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
||||
### Follow best practices
|
||||
|
||||
You should aim to follow best practices with your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
|
|
|||
|
|
@ -563,3 +563,7 @@ For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-g
|
|||
### Share your app
|
||||
|
||||
If you want to share your app with other users and organizations, make your app public. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/making-a-github-app-public-or-private)."
|
||||
|
||||
### Follow best practices
|
||||
|
||||
You should aim to follow best practices with your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
|
|
|||
|
|
@ -426,3 +426,7 @@ This tutorial generates a user access token. Unless you opted out of expiration
|
|||
If you plan on interacting further with {% data variables.product.company_short %}'s APIs, you should store the token for future use. If you choose to store the user access token or refresh token, you must store it securely. You should never publicize the token.
|
||||
|
||||
For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
||||
### Follow best practices
|
||||
|
||||
You should aim to follow best practices with your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
|
|
|||
|
|
@ -160,3 +160,7 @@ You should never publicize your app's private key or webhook secret. This tutori
|
|||
### Share your app
|
||||
|
||||
If you want to share your app with other users and organizations, make your app public. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/making-a-github-app-public-or-private)."
|
||||
|
||||
### Follow best practices
|
||||
|
||||
You should aim to follow best practices with your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
|
|
|||
|
|
@ -59,6 +59,16 @@ You can create a {% data variables.product.prodname_github_app %} owned by your
|
|||
1. Under "Where can this GitHub App be installed?", select **Only on this account** or **Any account**. For more information on installation options, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private)."
|
||||
1. Click **Create GitHub App**.
|
||||
|
||||
## Further reading
|
||||
## Next steps
|
||||
|
||||
- "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app)"
|
||||
After creating a {% data variables.product.prodname_github_app %}, you will want to write code to make your {% data variables.product.prodname_github_app %} do something. For examples of how to write code, see:
|
||||
|
||||
- "[AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)"
|
||||
- "[AUTOTITLE](/apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app)"
|
||||
- "[AUTOTITLE](/apps/creating-github-apps/guides/building-a-cli-with-a-github-app)"
|
||||
|
||||
You should aim to follow best practices. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app)."
|
||||
|
||||
Once your {% data variables.product.prodname_github_app %} is fully built, you can install your {% data variables.product.prodname_github_app %} and share your {% data variables.product.prodname_github_app %} with others. For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)" and "[AUTOTITLE](/apps/sharing-github-apps/sharing-your-github-app)."
|
||||
|
||||
You can always make changes to the settings for your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app)."
|
||||
|
|
|
|||
|
|
@ -13,8 +13,6 @@ topics:
|
|||
- GitHub Apps
|
||||
children:
|
||||
- /about-creating-github-apps
|
||||
- /migrating-oauth-apps-to-github-apps
|
||||
- /best-practices-for-creating-a-github-app
|
||||
- /creating-a-github-app
|
||||
- /about-the-user-authorization-callback-url
|
||||
- /about-the-setup-url
|
||||
|
|
@ -23,5 +21,7 @@ children:
|
|||
- /making-a-github-app-public-or-private
|
||||
- /rate-limits-for-github-apps
|
||||
- /creating-a-custom-badge-for-your-github-app
|
||||
- /migrating-oauth-apps-to-github-apps
|
||||
- /best-practices-for-creating-a-github-app
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ To pre-select any repositories your {% data variables.product.prodname_oauth_app
|
|||
|
||||
For example: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID`.
|
||||
|
||||
{% ifversion ghec or fpt %}For more information about installing {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% endif %}
|
||||
For more information about installing {% data variables.product.prodname_github_app %}s, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations),"{% endif %} "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)" and "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)."
|
||||
|
||||
#### Prompt users to authorize your app
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,12 @@ topics:
|
|||
- GitHub Apps
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: If you want to remove a {% data variables.product.prodname_github_app %} that you use but do not own, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access)" instead.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About deleting {% data variables.product.prodname_github_app %}s
|
||||
|
||||
If you own a {% data variables.product.prodname_github_app %} or are an app manager for a {% data variables.product.prodname_github_app %}, you can delete the {% data variables.product.prodname_github_app %}. For more information about {% data variables.product.prodname_github_app %} managers, see "[AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers)."
|
||||
|
|
|
|||
|
|
@ -15,6 +15,12 @@ topics:
|
|||
shortTitle: Suspend an installation
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: If you want to suspend a {% data variables.product.prodname_github_app %} that you use but do not own, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access)" instead.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
When a {% data variables.product.prodname_github_app %} is suspended for an installation, the {% data variables.product.prodname_github_app %} cannot access resources owned by that installation account. For example, you might want to suspend your {% data variables.product.prodname_github_app %} if you are worried that your app's credentials were leaked.
|
||||
|
||||
The owner of a {% data variables.product.prodname_github_app %} can suspend the {% data variables.product.prodname_github_app %} for a specific installation. If an organization has designated any app managers for an app owned by the organization, the app managers can also suspend the {% data variables.product.prodname_github_app %} for a specific installation. {% data variables.product.prodname_github_app %} owners and managers can only use the API to suspend their app, and they must suspend the app individually for each installation. For more information, see "[AUTOTITLE](/rest/apps/apps#suspend-an-app-installation)."
|
||||
|
|
|
|||
|
|
@ -11,6 +11,9 @@ redirect_from:
|
|||
- /developers/github-marketplace/customer-experience-best-practices-for-apps
|
||||
- /developers/github-marketplace/creating-apps-for-github-marketplace/customer-experience-best-practices-for-apps
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
If you follow these best practices it will help you to provide a good customer experience.
|
||||
|
||||
## Customer communication
|
||||
|
|
|
|||
|
|
@ -17,6 +17,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Listing requirements
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
<!--UI-LINK: Displayed as a link on the https://github.com/marketplace/new page.-->
|
||||
|
||||
The requirements for listing an app on {% data variables.product.prodname_marketplace %} vary according to whether you want to offer a free or a paid app.
|
||||
|
|
|
|||
|
|
@ -15,6 +15,9 @@ versions:
|
|||
topics:
|
||||
- Marketplace
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
If you follow these best practices it will help you to provide a secure user experience.
|
||||
|
||||
## Authorization, authentication, and access control
|
||||
|
|
|
|||
|
|
@ -15,6 +15,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: View listing metrics
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
You can view metrics for the past day (24 hours), week, month, or for the entire duration of time that your {% data variables.product.prodname_github_app %} has been listed.
|
||||
|
||||
{% note %}
|
||||
|
|
|
|||
|
|
@ -12,6 +12,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: View listing transactions
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Because it takes time to aggregate data, you'll notice a slight delay in the dates shown. When you select a time period, you can see exact dates for the metrics at the top of the page.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: About marketplace badges
|
||||
intro: 'Learn about the badges that you may see for some apps and actions listings on {% data variables.product.prodname_marketplace %}.'
|
||||
intro: 'Learn about the badges that you may see for some apps listings on {% data variables.product.prodname_marketplace %}.'
|
||||
redirect_from:
|
||||
- /developers/github-marketplace/about-verified-creator-badges
|
||||
- /developers/github-marketplace/about-marketplace-badges
|
||||
|
|
@ -9,7 +9,8 @@ versions:
|
|||
fpt: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
## For {% data variables.product.prodname_github_apps %}
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
Certain apps on the {% data variables.product.prodname_marketplace %} have the {% octicon "verified" aria-label="The verified badge" %} badge and a tooltip that says "Publisher domain and email verified". This means that the app is owned by an organization that has:
|
||||
|
||||
|
|
@ -32,11 +33,3 @@ Some apps on the {% data variables.product.prodname_marketplace %} have the {% o
|
|||
For more information about the requirements for listing an app on {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
For information on finding apps to use, see "[AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace)."
|
||||
|
||||
## For {% data variables.product.prodname_actions %}
|
||||
|
||||
Actions with the {% octicon "verified" aria-label="The verified badge" %}, or verified creator badge, indicate that {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. Partners can email <a href="mailto:partnerships@github.com">partnerships@github.com</a> to request the verified creator badge.
|
||||
|
||||
|
||||
|
||||
For information on how to publish a {% data variables.product.company_short %} action to {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)."
|
||||
|
|
|
|||
|
|
@ -11,6 +11,9 @@ redirect_from:
|
|||
- /developers/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization
|
||||
shortTitle: Publisher verification
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
Publisher verification ensures that {% data variables.product.prodname_dotcom %} has a way to contact you, that you've enabled two-factor authentication for your organization, and that your organization's domain has been verified.
|
||||
|
||||
Once your organization has been verified, you can publish paid plans for your app. For information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/setting-pricing-plans-for-your-listing)."
|
||||
|
|
|
|||
|
|
@ -16,6 +16,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Webhooks for plan changes
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
The {% data variables.product.prodname_marketplace %} event webhook can only be set up from your application's {% data variables.product.prodname_marketplace %} listing page. You can configure all other events from your [application's developer settings page](https://github.com/settings/developers). If you haven't created a {% data variables.product.prodname_marketplace %} listing, read "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app)" to learn how.
|
||||
|
||||
## Creating a webhook
|
||||
|
|
|
|||
|
|
@ -21,6 +21,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Draft an app listing
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
## Create a new draft {% data variables.product.prodname_marketplace %} listing
|
||||
|
||||
You can only create draft listings for apps that are public. Before creating your draft listing, you can read the following guidelines for writing and configuring settings in your {% data variables.product.prodname_marketplace %} listing:
|
||||
|
|
|
|||
|
|
@ -22,6 +22,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Set listing pricing plans
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
## About setting pricing plans
|
||||
|
||||
{% data variables.product.prodname_marketplace %} offers several different types of pricing plans. For detailed information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/selling-your-app-on-github-marketplace/pricing-plans-for-github-marketplace-apps)."
|
||||
|
|
|
|||
|
|
@ -13,6 +13,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Submit your listing
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
Once your app listing meets the {% data variables.product.prodname_marketplace %} requirements, you can submit your app. For an overview of the app listing requirements, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app)."
|
||||
|
||||
1. In the left sidebar on the app listing page, click **Overview**. For information on finding your app listing page, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app)."
|
||||
|
|
|
|||
|
|
@ -19,6 +19,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Write listing descriptions
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
Here are guidelines about the fields you'll need to fill out in the **Listing description** section of your draft listing.
|
||||
|
||||
## Naming and links
|
||||
|
|
|
|||
|
|
@ -13,6 +13,9 @@ versions:
|
|||
topics:
|
||||
- Marketplace
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
## Understanding the billing cycle
|
||||
|
||||
Customers can choose a monthly or yearly billing cycle when they purchase your app. All changes customers make to the billing cycle and plan selection will trigger a `marketplace_purchase` event. You can refer to the `marketplace_purchase` webhook payload to see which billing cycle a customer selects and when the next billing date begins (`effective_date`). For more information about webhook payloads, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api)."
|
||||
|
|
|
|||
|
|
@ -13,6 +13,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Pricing plans for apps
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
{% data variables.product.prodname_marketplace %} pricing plans can be free, flat rate, or per-unit. Prices are set, displayed, and processed in US dollars. Paid plans are restricted to apps published by verified publishers. For more information about becoming a verified publisher, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization)."
|
||||
|
||||
Customers purchase your app using a payment method attached to their account on {% data variables.location.product_location %}, without having to leave {% data variables.product.prodname_dotcom_the_website %}. You don't have to write code to perform billing transactions, but you will have to handle events from the {% data variables.product.prodname_marketplace %} API. For more information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app)."
|
||||
|
|
|
|||
|
|
@ -16,6 +16,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Receive payment
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
After your {% data variables.product.prodname_marketplace %} listing for an app with a paid plan is created and approved, you'll provide payment details to {% data variables.product.product_name %} as part of the financial onboarding process.
|
||||
|
||||
Once your revenue reaches a minimum of 500 US dollars for the month, you'll receive an electronic payment from {% data variables.product.company_short %}. This will be the income from marketplace transactions minus the amount charged by {% data variables.product.company_short %} to cover their running costs.
|
||||
|
|
|
|||
|
|
@ -15,6 +15,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: New purchases & free trials
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
If you offer a {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, your app must identify users following the OAuth authorization flow. You don't need to set up a separate {% data variables.product.prodname_oauth_app %} to support this flow. See "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps)" for more information.
|
||||
|
|
|
|||
|
|
@ -14,6 +14,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Plan cancellations
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
For more information about cancelling as it relates to billing, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/selling-your-app-on-github-marketplace/billing-customers)."
|
||||
|
||||
## Step 1. Cancellation event
|
||||
|
|
|
|||
|
|
@ -13,6 +13,9 @@ versions:
|
|||
topics:
|
||||
- Marketplace
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
For more information about upgrading and downgrading as it relates to billing, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app)."
|
||||
|
||||
## Step 1. Pricing plan change event
|
||||
|
|
|
|||
|
|
@ -14,6 +14,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: REST API
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
Here are some useful endpoints available for Marketplace listings:
|
||||
|
||||
* [List plans](/rest/apps#list-plans)
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ topics:
|
|||
- Marketplace
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
## Testing apps
|
||||
|
||||
You can use a draft {% data variables.product.prodname_marketplace %} listing to simulate each of the billing flows. A listing in the draft state means that it has not been submitted for approval. Any purchases you make using a draft {% data variables.product.prodname_marketplace %} listing will _not_ create real transactions, and GitHub will not charge your credit card. Note that you can only simulate purchases for plans published in the draft listing and not for draft plans. For more information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app)" and "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app)."
|
||||
|
|
|
|||
|
|
@ -14,6 +14,9 @@ topics:
|
|||
- Marketplace
|
||||
shortTitle: Webhook events
|
||||
---
|
||||
|
||||
{% data reusables.marketplace.marketplace-apps-not-actions %}
|
||||
|
||||
## About webhooks and {% data variables.product.prodname_marketplace %}
|
||||
|
||||
Webhooks `POST` requests have special headers. See "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#delivery-headers)" for more details. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub.
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ You can also build your own {% data variables.product.prodname_github_app %}. Fo
|
|||
|
||||
## Using {% data variables.product.prodname_github_app %}s
|
||||
|
||||
In order to use a {% data variables.product.prodname_github_app %}, you must install the app on your user or organization account. When you install the app, you grant the app permission to read or modify your repository and organization data. The specific permissions depends on the app, and {% data variables.product.company_short %} will tell you what permissions the app requested before you install the app. When you install the app, you will also specify what repositories the app can access. If the app requires any additional configuration, the app will direct you to do so. For more information, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% else %}"[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps)."{% endif %}
|
||||
In order to use a {% data variables.product.prodname_github_app %}, you must install the app on your user or organization account. When you install the app, you grant the app permission to read or modify your repository and organization data. The specific permissions depends on the app, and {% data variables.product.company_short %} will tell you what permissions the app requested before you install the app. When you install the app, you will also specify what repositories the app can access. If the app requires any additional configuration, the app will direct you to do so. For more information, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations),"{% endif %} "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)" and "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)."
|
||||
|
||||
You may also need to authorize a {% data variables.product.prodname_github_app %} to verify your identity, know what resources you can access, or take actions on your behalf. If you need to authorize the app, the app will prompt you to do so. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
|
||||
|
||||
Occasionally, the {% data variables.product.prodname_github_app %} will request updated permissions. {% data variables.product.company_short %} will notify you when this occurs. In order for the app to continue to function, you will need to review and approve the updated permissions. For more information, see "[AUTOTITLE](/apps/using-github-apps/approving-updated-permissions-for-a-github-app)."
|
||||
|
||||
Before you install or authorize a {% data variables.product.prodname_github_app %}, you should make sure that you trust the app developer. If you no longer use the app, you should suspend or uninstall the app and/or revoke your authorization of the app. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/suspending-a-github-app-installation)" and "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)."
|
||||
Before you install or authorize a {% data variables.product.prodname_github_app %}, you should make sure that you trust the app developer. If you no longer use the app, you should suspend or uninstall the app and/or revoke your authorization of the app. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#blocking-access)" and "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)."
|
||||
|
||||
## {% data variables.product.prodname_github_app %}s and OAuth Apps
|
||||
|
||||
|
|
@ -38,6 +38,6 @@ Before you install or authorize a {% data variables.product.prodname_github_app
|
|||
|
||||
Both {% data variables.product.prodname_oauth_app %}s and {% data variables.product.prodname_github_app %}s use OAuth 2.0.
|
||||
|
||||
{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user.
|
||||
{% data variables.product.prodname_oauth_app %}s can only act on behalf of a user, while {% data variables.product.prodname_github_app %}s can either act on behalf of a user or independently of a user.
|
||||
|
||||
For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps)" and "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ children:
|
|||
- /about-using-github-apps
|
||||
- /installing-a-github-app-from-github-marketplace-for-your-personal-account
|
||||
- /installing-a-github-app-from-github-marketplace-for-your-organizations
|
||||
- /installing-your-own-github-app
|
||||
- /installing-a-github-app-from-a-third-party
|
||||
- /installing-your-own-github-app
|
||||
- /authorizing-github-apps
|
||||
- /approving-updated-permissions-for-a-github-app
|
||||
- /reviewing-and-revoking-authorization-of-github-apps
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ shortTitle: Install from third party
|
|||
|
||||
{% ifversion ghes or ghae %}
|
||||
|
||||
You cannot install third-party {% data variables.product.prodname_github_app %}s on organizations owned by your enterprise. If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about creating an app from a manifest or from URL parameters. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters)." Once you create the {% data variables.product.prodname_github_app %} from the manifest or URL parameters, you will install your app and share your app credentials with the third party.
|
||||
You cannot install third-party {% data variables.product.prodname_github_app %}s on organizations owned by your instance.{% ifversion ghes %} If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about making the {% data variables.product.prodname_github_app %} available for {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server)."{% endif %}
|
||||
|
||||
For more information about installing {% data variables.product.prodname_github_app %}s that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)."
|
||||
|
||||
|
|
@ -19,9 +19,7 @@ For more information about installing {% data variables.product.prodname_github_
|
|||
|
||||
## About installing {% data variables.product.prodname_github_app %}s
|
||||
|
||||
{% ifversion ghec or fpt %}
|
||||
This article describes how to install a {% data variables.product.prodname_github_app %} directly from the app owner instead of from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-organization)."
|
||||
{% endif %}
|
||||
This article describes how to install a {% data variables.product.prodname_github_app %} directly from the app owner instead of from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-organization)." For more information about installing {% data variables.product.prodname_github_app %}s that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)."
|
||||
|
||||
{% data reusables.apps.about-installation %}
|
||||
|
||||
|
|
@ -57,6 +55,6 @@ During the installation process, the app owner will direct you to a {% data vari
|
|||
|
||||
If the app creates any repositories, the app will automatically be granted access to those repositories as well.
|
||||
1. Review the permissions that the app is requesting. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps)."
|
||||
1. Click **Install**, **Install and request**, or **Request**. The button that is presented depends on whether your organization owner must approve some or all of the requested access for the app.
|
||||
1. Click **Install**, **Install and request**, or **Request**. The button that is presented depends on whether your organization owner must approve none, some, or all of the requested access for the app. For more information, see "[Requirements to install a {% data variables.product.prodname_github_app %}](#requirements-to-install-a-github-app)."
|
||||
|
||||
{% endif %}
|
||||
|
|
@ -24,7 +24,7 @@ If you install a {% data variables.product.prodname_github_app %} on your organi
|
|||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)."
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %} instead of a {% data variables.product.prodname_github_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)."
|
||||
|
||||
## About installing {% data variables.product.prodname_github_app %}s
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ If you install a {% data variables.product.prodname_github_app %} on your person
|
|||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)."
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %} instead of a {% data variables.product.prodname_github_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)."
|
||||
|
||||
## About installing {% data variables.product.prodname_github_app %}s
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Installing your own GitHub App
|
||||
intro: 'You can install a {% data variables.product.prodname_github_app %} that you created on the user or organization account that owns the app. If your app is public, the {% data variables.product.prodname_github_app %} can also be installed on other accounts.'
|
||||
intro: 'You can install a {% data variables.product.prodname_github_app %} that you created on the personal or organization account that owns the app. If your app is public, the {% data variables.product.prodname_github_app %} can also be installed on other accounts.'
|
||||
redirect_from:
|
||||
- /apps/installing-github-apps
|
||||
- /developers/apps/installing-github-apps
|
||||
|
|
@ -19,7 +19,7 @@ shortTitle: Install your own app
|
|||
|
||||
## About installing your own {% data variables.product.prodname_github_app %}
|
||||
|
||||
Once you create a {% data variables.product.prodname_github_app %}, you can install it. If your {% data variables.product.prodname_github_app %} is owned by a personal account{% ifversion ghec%} and you are not an {% data variables.product.prodname_emu %}{% endif %}, you can install it on your account. If your {% data variables.product.prodname_github_app %} is owned by an organization and you are an organization owner, you can install it on your organization.
|
||||
Once you create a {% data variables.product.prodname_github_app %}, you can install it. If your {% data variables.product.prodname_github_app %} is owned by a personal account{% ifversion ghec%} and you are not an {% data variables.product.prodname_emu %}{% endif %}, you can install it on your account. If your {% data variables.product.prodname_github_app %} is owned by an organization and you are an organization owner, you can install it on the organization.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
If your {% data variables.product.prodname_github_app %} is public{% ifversion ghec%} and you are not an {% data variables.product.prodname_emu %}{% endif %}, you can also share your {% data variables.product.prodname_github_app %} with other users or organizations. {% ifversion ghec%}If you are an {% data variables.product.prodname_emu %}, then you can only share your app with other organizations within your enterprise.{% endif %}For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/sharing-your-github-app)."
|
||||
|
|
|
|||
|
|
@ -22,16 +22,16 @@ shortTitle: Review your authorizations
|
|||
|
||||
You may authorize a {% data variables.product.prodname_github_app %} to give the app permission to access information on your {% data variables.product.company_short %} account and to act on your behalf. For more information, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
|
||||
|
||||
You should periodically review the apps that you have authorized. If you no longer use an app, consider revoking your authorization for that app.
|
||||
You should periodically review the {% data variables.product.prodname_github_app %}s that you have authorized. If you no longer use an app, consider revoking your authorization for that app.
|
||||
|
||||
The authorization can only be revoked by the person who authorized the {% data variables.product.prodname_github_app %}. Organization owners cannot revoke app authorizations for their organization members. However, organization owners can uninstall the app from their organization, which will prevent the app from accessing organization-owned resources. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps)."
|
||||
The authorization can only be revoked by the person who authorized the {% data variables.product.prodname_github_app %}. Organization owners cannot revoke {% data variables.product.prodname_github_app %} authorizations for their organization members. However, organization owners can uninstall the {% data variables.product.prodname_github_app %} from their organization, which will prevent the app from accessing organization-owned resources. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps)."
|
||||
|
||||
## Reviewing your authorized {% data variables.product.prodname_github_apps %}
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.access_applications %}
|
||||
3. Click the **Authorized {% data variables.product.prodname_github_apps %}** tab.
|
||||
3. Review the {% data variables.product.prodname_github_apps %} that have access to your account. For those that you don't recognize or that are out of date, click **Revoke**. To revoke all {% data variables.product.prodname_github_apps %}, click **Revoke all**.
|
||||
3. Review the {% data variables.product.prodname_github_apps %} that have access to your account. For those that you don't recognize or that have not been used recently, click **Revoke**. To revoke your authorization for all {% data variables.product.prodname_github_apps %}, click **Revoke all**.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
In order to use a {% data variables.product.prodname_github_app %} on your repositories or organization, you must install the app.
|
||||
In order to use a {% data variables.product.prodname_github_app %} on your repositories or organization, you must install the app on your organization or personal account. You can install the same {% data variables.product.prodname_github_app %} on multiple accounts. For example, if you install the app on your personal account and on a few organizations that you own, you'll be able to use the app on your personal repositories, on the organizations where you installed the app, and on repositories owned by those organizations.
|
||||
|
||||
When you install an app, you grant the app permission to access the organization and repository resources that it requested. During the installation process, {% data variables.product.company_short %} will tell you which permissions the {% data variables.product.prodname_github_app %} requested. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps)."
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
When you **install** a {% data variables.product.prodname_github_app %} on your account or organization, you grant the app permission to access the organization and repository resources that it requested. You also specify which repositories the app can access. During the installation process, the {% data variables.product.prodname_github_app %} will indicate which repository and organization permissions you are granting. For more information about what different permissions enable a {% data variables.product.prodname_github_app %} to do, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/choosing-permissions-for-a-github-app)."
|
||||
|
||||
|
||||
For example, you might grant the {% data variables.product.prodname_github_app %} permission to write issues and read repository metadata, and you might grant the {% data variables.product.prodname_github_app %} access to all of your repositories.
|
||||
For example, you might grant the {% data variables.product.prodname_github_app %} permission to read repository metadata and write issues, and you might grant the {% data variables.product.prodname_github_app %} access to all of your repositories.
|
||||
|
||||
|
||||
|
||||
When you **authorize** a {% data variables.product.prodname_github_app %}, you grant the app access to your {% data variables.product.prodname_dotcom %} account, based on the account permissions the app requested. During the authorization process, the app will indicate which resources the app can access on your account. When you authorize a {% data variables.product.prodname_github_app %}, you also grant the app permission to act on your behalf.
|
||||
|
||||
For example, you might grant the {% data variables.product.prodname_github_app %} permission to view your email addresses and write Gists.
|
||||
For example, you might grant the {% data variables.product.prodname_github_app %} permission to read your email addresses and write gists.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
{% note %}
|
||||
|
||||
**Note:** This article applies to publishing {% data variables.product.prodname_github_app %}s in {% data variables.product.prodname_marketplace %} only. For more information about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)."
|
||||
|
||||
{% endnote %}
|
||||
Загрузка…
Ссылка в новой задаче