Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): add example for using a custom Agent #614

Merged
merged 4 commits into from
Jul 10, 2023

Conversation

oscard0m
Copy link
Member

@oscard0m oscard0m commented Jul 10, 2023

Resolves #613


Behavior

Before the change?

No documentation on how to set an Agent to octokit.request internal fetch.

After the change?

Documentation on how to set an Agent to octokit.request internal fetch.

Other information


Additional info

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes (Please add the Type: Breaking change label)
  • No

If Yes, what's the impact:

  • N/A

Pull request type

Type: Documentation


@oscard0m oscard0m added the Type: Documentation Improvements or additions to documentation label Jul 10, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
oscard0m and others added 3 commits July 10, 2023 19:00
Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>
Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>
Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>
@oscard0m oscard0m requested a review from gr2m July 10, 2023 17:02
@oscard0m oscard0m enabled auto-merge (squash) July 10, 2023 17:03
Copy link
Contributor

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Oscar for taking this on!

If you like, a great follow up would be to re-enable tests in @octokit/core based on your code

See

I'd start by creating an issue in @octokit/core and then take it from there

@github-actions
Copy link

🎉 This PR is included in version 8.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Document on how to use the new fetch API equivalent to http agents
2 participants