Skip to content

Commit

Permalink
Document support for GitHub token authentication (#177)
Browse files Browse the repository at this point in the history
* Added documentation for #84

* fixed spacing issue

* Uppercase

* Uppercase

* Remove trailing spaces

* Update `README.md`

* Remove remaining trailing space

---------

Co-authored-by: Edmund Turbin <edmund.turbin@pantheon.io>
Co-authored-by: Daniel Bachhuber <daniel@bachhuber.co>
Co-authored-by: Daniel Bachhuber <daniel.bachhuber@automattic.com>
  • Loading branch information
4 people committed Aug 27, 2023
1 parent 88b7728 commit de6d7ad
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,13 @@ reference breaks.
When installing a .zip file, WP-CLI extracts the package to
`~/.wp-cli/packages/local/<package-name>`.

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

**OPTIONS**

<name|git|path|zip>
Expand Down
7 changes: 7 additions & 0 deletions src/Package_Command.php
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,13 @@ public function browse( $_, $assoc_args ) {
* When installing a .zip file, WP-CLI extracts the package to
* `~/.wp-cli/packages/local/<package-name>`.
*
* If Github token authorization is required, a GitHub Personal Access Token
* (https://github.com/settings/tokens) can be used. The following command
* will add a GitHub Personal Access Token to Composer's global configuration:
* composer config -g github-oauth.github.com <GITHUB_TOKEN>
* Once this has been added, the value used for <GITHUB_TOKEN> will be used
* for future authorization requests.
*
* ## OPTIONS
*
* <name|git|path|zip>
Expand Down

0 comments on commit de6d7ad

Please sign in to comment.