Document the use of authenticate() using ENV variable

[ucorpintegration]

In config/packages/github.yml , there is:

services:
    Github\Client:
        arguments:
            - '@Github\HttpClient\Builder'
        calls:
            - ['authenticate', ['%env(GITHUB_USERNAME)%', '%env(GITHUB_SECRET)%', '%env(GITHUB_AUTH_METHOD)%']]

But how to use it?
Not knowing how to use it, I temporarily put the credentials in the code.

[acrobat]

I'm not sure what you exact question is here. The service config above looks correct and you should define the mentioned environment variables then authentication is correctly setup.

After that you can inject the Github\Client service into you classes and call the api endpoints

[acrobat]

Closing this issue as I consider it answered/solved. Please re-open if you still have problem!

[tresf]

I have a similar issue as the OP. Configuring the environment is rather trivial, as @acrobat has identified, however troubleshooting issues is difficult because the parameters aren't part of any (obvious?) documentation.

For example, take the following .env file:

GITHUB_USERNAME=username
GITHUB_SECRET=password_or_token
GITHUB_AUTH_METHOD=http_password

If these are omitted, errors are as we'd expect...

- Environment variable not found: "GITHUB_USERNAME".
- Environment variable not found: "GITHUB_SECRET".
- Environment variable not found: "GITHUB_AUTH_METHOD".

And although GITHUB_USERNAME and GITHUB_SECRET are rather obvious, I feel that GITHUB_AUTH_METHOD is not. Searching this project for GITHUB_AUTH_METHOD returns one result (this bug report). Most examples recommend a value of http_password as mentioned, but this results in a new error:

- Github\Exception\RuntimeException: "http_token not yet implemented" at /home/owner/lmms.io/vendor/knplabs/github-api/lib/Github/HttpClient/Plugin/Authentication.php

Common sense says that this is incorrect usage (or perhaps an outdated library?) but my Google Fu is returning very little results, leaving doubt. 🍻

[tresf]

I got it working using this, per

php-github-api/lib/Github/AuthMethod.php

Line 19 in 0e2399c

public const ACCESS_TOKEN = 'access_token_header';

- GITHUB_AUTH_METHOD=http_password
+ GITHUB_AUTH_METHOD=client_id_header