Skip to content

Commit de6d7ad

Browse files
spicecadetEdmund Turbindanielbachhuber
authored
Document support for GitHub token authentication (#177)
* Added documentation for #84 * fixed spacing issue * Uppercase * Uppercase * Remove trailing spaces * Update `README.md` * Remove remaining trailing space --------- Co-authored-by: Edmund Turbin <[email protected]> Co-authored-by: Daniel Bachhuber <[email protected]> Co-authored-by: Daniel Bachhuber <[email protected]>
1 parent 88b7728 commit de6d7ad

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,13 @@ reference breaks.
151151
When installing a .zip file, WP-CLI extracts the package to
152152
`~/.wp-cli/packages/local/<package-name>`.
153153

154+
If Github token authorization is required, a GitHub Personal Access Token
155+
(https://github.com/settings/tokens) can be used. The following command
156+
will add a GitHub Personal Access Token to Composer's global configuration:
157+
composer config -g github-oauth.github.com <GITHUB_TOKEN>
158+
Once this has been added, the value used for <GITHUB_TOKEN> will be used
159+
for future authorization requests.
160+
154161
**OPTIONS**
155162

156163
<name|git|path|zip>

src/Package_Command.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,13 @@ public function browse( $_, $assoc_args ) {
188188
* When installing a .zip file, WP-CLI extracts the package to
189189
* `~/.wp-cli/packages/local/<package-name>`.
190190
*
191+
* If Github token authorization is required, a GitHub Personal Access Token
192+
* (https://github.com/settings/tokens) can be used. The following command
193+
* will add a GitHub Personal Access Token to Composer's global configuration:
194+
* composer config -g github-oauth.github.com <GITHUB_TOKEN>
195+
* Once this has been added, the value used for <GITHUB_TOKEN> will be used
196+
* for future authorization requests.
197+
*
191198
* ## OPTIONS
192199
*
193200
* <name|git|path|zip>

0 commit comments

Comments
 (0)