1
0
mirror of synced 2025-12-21 19:06:49 -05:00
Commit Graph

110 Commits

Author SHA1 Message Date
Matt Pollard
16ff92ca4e Replace explicit mentions of api subdomain for GitHub Enterprise Server and GitHub AE documentation (#20013) 2021-06-22 10:47:29 +02:00
Grace Park
6f7e4f50dc updating content files 2021-06-14 12:06:52 -07:00
Lucas Costi
4556d21876 Fix POST->GET for listing GitHub App installations (#7206) 2021-06-09 23:50:41 +00:00
Wilson Wong
e1ac544f50 Adding OAuth App token limits (#19772) 2021-06-09 11:07:56 +01:00
hubwriter
093e6f6665 Document GitHub Apps allow lists (#19564) 2021-06-08 14:07:18 -05:00
Shati Patel
a45f0633f5 Update scopes-for-oauth-apps.md (#19696)
Co-authored-by: hubwriter <hubwriter@github.com>
2021-06-04 15:20:59 +00:00
Carlos Cuellar
1bf890562e Remove webhook_secret from Creating GitHub App via URL params (#19601) 2021-05-28 17:19:07 +00:00
Amanda Lin
19a8bd716e prefix /repos for content attachment API (#19606) 2021-05-28 11:08:16 +10:00
Francis
82650049ce Enhancement: improve instructions for authenticating as an installation (#19474) 2021-05-24 16:51:03 -07:00
Steve Guntrip
5281e2179a remove unused state param 2021-05-21 11:02:51 +01:00
jmarlena
7ec2c09178 Merge branch 'main' into patch-1 2021-05-20 16:17:24 -07:00
jmarlena
62c2877e1d Tiny style tweak 2021-05-20 15:31:43 -07:00
Amanda Lin
6decb0b312 Update using content attachments (#19407) 2021-05-19 23:35:59 +00:00
Cees-Jan Kiewiet
1b11d1bb06 Clariry that App ID !== Client ID
When implementing this I made the mistake of assuming that the Client ID would be the same as the App ID. A few frustrating hours and a support ticket later I was pointed out this important difference. This commit introduces a small note about this difference. Hopefully saving others a few hours of trying to figure this out.
2021-05-19 20:28:56 +02:00
Sarah Schneider
f7e848e0c4 ran script/content-migrations/remove-map-topics.js && script/content-migrations/update-tocs.js 2021-05-19 10:12:38 -04:00
shashank bansal
3e290183f7 Minor text updates to apps and marketplace based on support feedback (#19263) 2021-05-18 01:00:36 +00:00
James Martin
f3b6db3137 Consistent use of "private" vs "internal" terms for GitHub Apps (#6030) 2021-05-13 20:52:53 +00:00
Simran
7ae0162760 Unify YAML indent (#6041) 2021-05-12 22:06:35 +00:00
Lucas Alves
df1ae6420c Updates REST API examples to HTTP/2 (#6002) 2021-05-06 21:30:50 +00:00
Rachael Sewell
a926da8b08 Update topics to sentence case (#19069) 2021-04-30 19:30:36 -07:00
Matias Albarello
3139864841 Update example with Octokit Checks API methods (#3375) 2021-04-21 23:25:19 +00:00
Gregor Martynus
3c6dc63cf9 docs(Creating a GitHub App from a manifest): POST /app-manifests/:code/conversions -> POST /app-manifests/{code}/conversions 2021-04-12 15:32:34 -07:00
Matt Pollard
d87de3189a Remove duplicate quotes in conditionals (#18633) 2021-04-08 12:30:52 +00:00
Lucas Costi
4780a16b84 Multi callback URLs future functionality: using URL parameters or manifests (#16233)
Co-authored-by: Heather Harvey <hmharvey@github.com>
2021-04-01 00:07:12 +00:00
Matt Pollard
9b06573be5 Document GitHub's new token formats (#18494) 2021-03-31 15:40:51 -07:00
thepeoplesbourgeois
30f71b4a7e Fix link for creating an app under an organization (#4806)
Co-authored-by: Sarah Edwards <skedwards88@github.com>
2021-03-28 03:24:11 +00:00
Emily Gould
5a20716c7e Restructure and move Git content (#18336)
* Rename map topic

* Delete map topic

* Rename map topic

* Add redirect

* Remove last two map topics

* Move article on adding a remote into a long-form guide

* Move article on changing a remote's URL

* Move articles on renaming and removing remotes

* Move remote URL article

* Fix typo

* Remove category index file

* Move a few articles to the new category

* Move a few more files

* Move managing remote repos article

* Move the rest of the getting started with git map topic

* Move the first half of the using git map topic

* Move the rest of the articles and 🔥 the directory

* Fix failing test

* Remove Using Git from product index

* Apply suggestions from code review

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Apply suggestions from code review

Co-authored-by: Laura Coursen <lecoursen@github.com>
2021-03-25 14:42:36 -05:00
Martin Lopes
6cffe943f2 Merge branch 'main' into patch-1 2021-03-25 10:28:14 +10:00
Janice
ed8dbaa0af Merge branch 'main' into patch-2 2021-03-24 16:14:16 -07:00
Martin Lopes
0c1c0152d9 Merge branch 'main' into patch-1 2021-03-25 09:10:02 +10:00
Martin Lopes
e7d61d9118 Update identifying-and-authorizing-users-for-github-apps.md 2021-03-25 09:09:21 +10:00
Felicity Chapman
28bec608c7 Group user docs on code security into a new "product" - with more redirects (#18278) 2021-03-22 09:28:35 +00:00
Janice
e8b46c6361 Merge branch 'main' into hotfix/about-app-links 2021-03-19 12:50:30 -07:00
Janice
4a5fd97c70 Update content/developers/apps/about-apps.md 2021-03-19 12:45:37 -07:00
Lucas Alves
2dfd3b3538 Update the relative link
Co-authored-by: Janice <janiceilene@github.com>
2021-03-19 00:38:24 -03:00
Rachael Sewell
b1b8cb8e84 add topic frontmatter to articles (#18245) 2021-03-17 12:31:29 -07:00
Felicity Chapman
6a7e93f225 Revert "Group user docs on code security into a new "product" (#18196)" (#18277) 2021-03-17 08:07:11 +00:00
Lucas Alves
035dfeddb7 Correction within the About apps page 2021-03-17 00:21:00 -03:00
Rachael Sewell
60bd45b503 Merge branch 'main' into repo-sync 2021-03-16 15:52:09 -07:00
Liam Newman
d862636cec "Issued at" time should allow for clock drift (#4156)
If `iat` is in the future from the server clock perspective GitHub will report an error. 
This can happen if the clock on the client system is significant out of sync with UTC and/or server time.

Adjusting `iat` to an arbitrary 60 seconds in the past means the error will not occur in cases where the client system clock is only off by a few seconds, which is not uncommon.
2021-03-16 19:48:37 +00:00
Felicity Chapman
024014740b Group user docs on code security into a new "product" (#18196) 2021-03-16 17:25:29 +00:00
Kenny
79fbdeb144 Fix .env examples for PRIVATE_KEY -> GITHUB_PRIVATE_KEY variables (#4305)
This fixes naming for a couple of variables in the `.env` examples in this document.  Currently there are examples which suggest naming the private key variable `PRIVATE_KEY`, when really it should be `GITHUB_PRIVATE_KEY`.  When following along in the example and attempting to run the server, using the incorrect name in the `.env` file leads to an error.

Co-authored-by: hubwriter <hubwriter@github.com>
2021-03-15 15:24:59 +00:00
Gregor Martynus
456e60fc2a GitHub Apps with expiring tokens: The "expires_in" and "refresh_token_expires_in" keys in the JSON response for code exchange are numbers, not strings
tested with curl

```shell
curl -v -XPOST https://github.com/login/oauth/access_token -H"Accept: application/json" -H"Content-Type: application/json" -d '{"client_id": "Iv1.ee8d48b9ae654ff5", "client_secret": "[REDACTED]", "code": "519a7bfd9cb8ab6cfac2"}'
{"access_token":"[REDACTED]","expires_in":28800,"refresh_token":"[REDACTED]","refresh_token_expires_in":15897600,"token_type":"bearer","scope":""}
```
2021-03-12 14:00:01 -08:00
Gregor Martynus
4351fce235 GitHub Apps OAuth Web Flow: document allow_signup parameter 2021-03-11 21:11:55 -08:00
mc
6a359d33ec Merge branch 'main' into gk/fix_deafult_perms_line_apps 2021-03-09 07:56:01 +00:00
jmarlena
ed5a109e48 [MERGES AFTER GHAE CB ships] Remove "public repository" wording for GHAE (#18008)
* Empty commit

* updated beta note for GHAE

* more GHAE update + resolve conflict

* more GHAE updates + prepare for screenshots

* Apply suggestions from code review

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* address remaining review comments

* Revise "About GitHub AE" (#17679)

* add screenshots to the Configuring article

* reworked to have a separate GHAE section

* list numbering

* more work on screenshots and conditions

* add GHAE screenshots in article

* review screenshots in article

* added more screenshots and updated more articles

* screenshot madness

* fix liquid versioning

* refactor the ghae script

* [GHAE CB/Feb 22]: Add article about data residency for GitHub AE (#17847)

* add missing GHAE versioning to article

* move screenshots to GHAE asset directory

* forgot to change the path for these two images

* replace CBB screenshot + add better screenshot

* [GHAE CB/Feb 22]: Document upgrades for GitHub AE (#17848)

* Version article for GitHub AE

* Replace unused variable

* Incorporate reviewer feedback

* Update intro

Co-authored-by: Ethan P <56270045+ethanpalm@users.noreply.github.com>

* [GHAE] Enable IP allow list (#17691)

* Notes for CC

* Updat permission leves chart

* Add updated article to further reading

* Update gated feature callout with GitHub AE

* Version "Managing allowed IP addresses for your organization" for AE

* Update images

* Update "Restricting network traffic to your enterprise" with new procedures

* remove todo note

* Update audited actions

* Update info about Premium Runners

* Use reusable for Premium Runners

* Change "Premium Runners" to "AE hosted runners"

* Incorporate reviewer feedback

* Use correct reusable

* Version reusable correctly

* [Feb 22] GHAE: Code scanning beta (#17830)

* Add "github-ae" to all the frontmatter

* GHAE-ify the reusables

* Add some more changes

* Re-use some content

* 🔪 Semmle links

* Revert change re "--external-repository-token" in the CodeQL runner

* Update CodeQL runner token scopes

* Update two screenshots

* Remove mention of GitHub.com from AE + other fixes

* Apply suggestions from code review

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>

* Use `product_name` variable instead of `product_location`

* Remove confusing phrase

* [Feb 22] GHAE: Code scanning API and webhook docs (#17883)

* Version API and webhook docs

* Actually add versioning for GHAE

* Fix anchor

* [TEMPORARY] Preview for API endpoints

* Revert API previews

* Update procedure step

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>

* Update docs for AzureAD Group SCIM support in GHAE (#17892)

* Version out reference to public Pages site for GHAE

* [GHAE CB] SMTP bootstrapping flow (#17888)

* draft

* update with AE conntent

* update with tons of versioning

* remove that  lie

* fill out the rest of these steps

* update with correct versioning

* more edits

* add images

* reversion most of ae article

* fix versioning

* format correctlly

* words matter

* last image

* update with permmissions

* update versioning

* add link

* apply feedback ❤️

* update with differrent spacing

* update with feedback

* more feedback

* Temporary GHAE release notes for consumables beta launch (#17859)

* Create release-notes.md

* Add frontmatter

* Add to index file

* Update github-ae-release-notes.md

* Add release notes from Google Doc

* Update finalized docs links that have been reviewed

* OAuth device flow link update

* version for AE

* few fixes

* Update content/admin/overview/github-ae-release-notes.md

* small edits

* whoops

* commit

* update with different links

* used wrong reusable

* fix more brokenness

* Update repository-references.js

* Update repository-references.js

Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>

* [GHAE] Audit public repos (#17917)

* verifying what we mean by public

* Apply suggestions from code review

* Update content/developers/apps/installing-github-apps.md

Co-authored-by: Laura Coursen <lecoursen@github.com>

* fixing placememnt of liquid conditional

Co-authored-by: Laura Coursen <lecoursen@github.com>

* GHAE packages beta (#17786)

Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Martin Lopes <martin389@github.com>

* Batch #1 of changes

* Batch #2

* getting started article update

* Update GraphQL article

* Only public repository reference

* Just update the link

* Update endpoint title to use "internal"

* fix build error

* placeholder update for updating `public_repo` scope in UI

* Remove unncessary versioning for now

* fix broken links

* Add REST API files

* Remove versioning since the endpoint "title" didn't get updated

* Version out the no scope option

* Evergreen rewrite

Co-Authored-By: Aaron Harpole <507570+aharpole@users.noreply.github.com>

* Add back public key

* Apply suggestions from code review

Co-authored-by: Alex Slepak <ams11@github.com>
Co-authored-by: Aaron Harpole <aharpole@github.com>

* Remove versioning and add evergreen rewrite

* Just the way it was before

* fix confusing legacy bit

* Apply suggestions from code review

Co-authored-by: Alex Slepak <ams11@github.com>

* Apply suggestions from code review

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* Movin' on up

* no versioning needed

* internal gists exist!

* Doesn't need versioning

* Keep this as-is

* Remove screenshots 💥

* Apply suggestions from code review

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* Never updated REST API docs with different endpoint name

* No versioning needed

* Merge conflict fix: Updated this article from main branch

* Apply suggestions from code review

* Revert "Add REST API files"

This reverts commit 1a8ad0adca47daaa1bf9d1b3642c4ec073564996.

* checkout changes from main

* Update OpenAPI Descriptions (#18103)

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: shati-patel <shati-patel@github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
Co-authored-by: skedwards88 <skedwards88@github.com>
Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com>
Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Aaron Harpole <507570+aharpole@users.noreply.github.com>
Co-authored-by: Alex Slepak <ams11@github.com>
Co-authored-by: Aaron Harpole <aharpole@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
2021-03-04 21:31:30 -08:00
mc
2f9d8d9a6e Update content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md 2021-03-03 17:00:08 +00:00
Rachael Sewell
aa5c5c3f29 Merge branch 'main' into repo-sync 2021-03-01 14:40:16 -08:00
Rachael Sewell
867518675c more image dedupe (#17980) 2021-03-01 22:08:23 +00:00
Janice
2440831733 Merge branch 'main' into add_answer_to_trubs_dev_app 2021-03-01 14:44:41 -07:00