Added missing parameters to GitHub app manifest. #23736

OlayinkaAtobiloye · 2023-02-06T19:02:45Z

Why:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
For content changes, I have completed the self-review checklist.

welcome · 2023-02-06T19:02:48Z

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

github-actions · 2023-02-06T19:10:39Z

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source	Preview	Production	What Changed
`developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md`	fpt ghec ghes@ 3.8 3.7 3.6 3.5 3.4 ghae	fpt ghec ghes@ 3.8 3.7 3.6 3.5 3.4 ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

cmwilson21 · 2023-02-07T15:26:04Z

👋 Hey @OlayinkaAtobiloye! 🎉 🥳

I'll get this triaged for writer review! 💖

sophietheking

Congrats on your first Docs PR! ✨🕺⚡🎉 I left two small suggestions, but this looks really good to me!

Feel free to @mention me here once you've looked at my suggestions and I'll get this merged for you.

sophietheking · 2023-02-07T16:08:11Z

content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md

@@ -67,6 +67,8 @@ The person creating the app will be redirected to a GitHub page with an input fi
 `public` | `boolean` | Set to `true` when your GitHub App is available to the public or `false` when it is only accessible to the owner of the app.
 `default_events` | `array` | The list of [events](/webhooks/event-payloads) the GitHub App subscribes to.
 `default_permissions` | `object` | The set of [permissions](/rest/reference/permissions-required-for-github-apps) needed by the GitHub App. The format of the object uses the permission name for the key (for example, `issues`) and the access type for the value (for example, `write`).
+`request_oauth_on_install` | `boolean` | Set to `true` to request the user to authorize the GitHub App, after the GitHub App is installed.


Suggested change

`request_oauth_on_install` | `boolean` | Set to `true` to request the user to authorize the GitHub App, after the GitHub App is installed.

`request_oauth_on_install` | `boolean` | Set to `true` to request the user to authorize the {% data variables.product.prodname_github_app %}, after the {% data variables.product.prodname_github_app %} is installed.

You can replace "GitHub App" with a variable (the string with the curly brackets) here. ✨ This makes product name changes easier to implement across the site and avoids typos in our product names. 🙇‍♀️ You can find the product variables in /data/variables/product.yml.

sophietheking · 2023-02-07T16:08:43Z

content/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest.md

@@ -67,6 +67,8 @@ The person creating the app will be redirected to a GitHub page with an input fi
 `public` | `boolean` | Set to `true` when your GitHub App is available to the public or `false` when it is only accessible to the owner of the app.
 `default_events` | `array` | The list of [events](/webhooks/event-payloads) the GitHub App subscribes to.
 `default_permissions` | `object` | The set of [permissions](/rest/reference/permissions-required-for-github-apps) needed by the GitHub App. The format of the object uses the permission name for the key (for example, `issues`) and the access type for the value (for example, `write`).
+`request_oauth_on_install` | `boolean` | Set to `true` to request the user to authorize the GitHub App, after the GitHub App is installed.
+`setup_on_update` | `boolean` | Set to `true` to redirect users to the `setup_url` after they update your GitHub App installation.


Suggested change

`setup_on_update` | `boolean` | Set to `true` to redirect users to the `setup_url` after they update your GitHub App installation.

`setup_on_update` | `boolean` | Set to `true` to redirect users to the `setup_url` after they update your {% data variables.product.prodname_github_app %} installation.

Same as above! 💖

Hi, @sophietheking, thanks for the review!, super helpful I have made the changes now.

…ere possible.

sophietheking

Looking good! Thanks for updating the other instances of "GitHub App" as well. 💖

sophietheking

Looking good! Thanks for updating the other instances of "GitHub App" as well. 💖

github-actions · 2023-02-08T08:14:23Z

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Added missing parameters to GitHub app manifest.

9f694fd

github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 6, 2023

OlayinkaAtobiloye mentioned this pull request Feb 6, 2023

Parameters missing from GitHub App Manifests #22315

Closed

1 task

cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review developers Content related to developers and removed triage Do not begin working on this issue until triaged by the team labels Feb 7, 2023

sophietheking assigned sophietheking and unassigned sophietheking Feb 7, 2023

sophietheking previously approved these changes Feb 7, 2023

View reviewed changes

Updated the code changes to use Variables as opposed to hardcoding wh…

bf21806

…ere possible.

OlayinkaAtobiloye dismissed sophietheking’s stale review via bf21806 February 7, 2023 17:19

OlayinkaAtobiloye added 2 commits February 7, 2023 17:41

Updated the code changes to use Variables as opposed to hardcoding wh…

471d27a

…ere possible.

Merge branch 'github:main' into main

0e1bbe2

sophietheking approved these changes Feb 8, 2023

View reviewed changes

Merge branch 'main' into main

af3b7fb

sophietheking added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Feb 8, 2023

sophietheking enabled auto-merge February 8, 2023 08:06

docubot added this to Triage in Docs open source board Feb 8, 2023

sophietheking merged commit 5cb0df8 into github:main Feb 8, 2023
16 checks passed

Docs open source board automation moved this from Triage to Done Feb 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added missing parameters to GitHub app manifest. #23736

Added missing parameters to GitHub app manifest. #23736

OlayinkaAtobiloye commented Feb 6, 2023 •

edited

welcome bot commented Feb 6, 2023

github-actions bot commented Feb 6, 2023 •

edited

cmwilson21 commented Feb 7, 2023

sophietheking left a comment

sophietheking Feb 7, 2023

sophietheking Feb 7, 2023

OlayinkaAtobiloye Feb 7, 2023

sophietheking left a comment

sophietheking left a comment

github-actions bot commented Feb 8, 2023

	`request_oauth_on_install` \| `boolean` \| Set to `true` to request the user to authorize the GitHub App, after the GitHub App is installed.
	`request_oauth_on_install` \| `boolean` \| Set to `true` to request the user to authorize the {% data variables.product.prodname_github_app %}, after the {% data variables.product.prodname_github_app %} is installed.

	`setup_on_update` \| `boolean` \| Set to `true` to redirect users to the `setup_url` after they update your GitHub App installation.
	`setup_on_update` \| `boolean` \| Set to `true` to redirect users to the `setup_url` after they update your {% data variables.product.prodname_github_app %} installation.

Added missing parameters to GitHub app manifest. #23736

Added missing parameters to GitHub app manifest. #23736

Conversation

OlayinkaAtobiloye commented Feb 6, 2023 • edited

Why:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

welcome bot commented Feb 6, 2023

github-actions bot commented Feb 6, 2023 • edited

Automatically generated comment ℹ️

Content directory changes

cmwilson21 commented Feb 7, 2023

sophietheking left a comment

Choose a reason for hiding this comment

sophietheking Feb 7, 2023

Choose a reason for hiding this comment

sophietheking Feb 7, 2023

Choose a reason for hiding this comment

OlayinkaAtobiloye Feb 7, 2023

Choose a reason for hiding this comment

sophietheking left a comment

Choose a reason for hiding this comment

sophietheking left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 8, 2023

OlayinkaAtobiloye commented Feb 6, 2023 •

edited

github-actions bot commented Feb 6, 2023 •

edited