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(development): fix ProbotOctokit usage example #1637

Merged
merged 2 commits into from Jan 18, 2022

Conversation

chris-schra
Copy link
Contributor

@chris-schra chris-schra commented Jan 17, 2022

The currently documented example

function myProbotApp(app) {
  const octokit = new ProbotOctokit({
    // any options you'd pass to Octokit
    auth: "token <myToken>",
    // and a logger
    log: app.log.child({ name: "my-octokit" }),
  });
}

does not work. It will return an error because of missing auth.

This PR modifies the example to show the currently supported way for token auth


View rendered docs/development.md

@chris-schra chris-schra requested a review from a team as a code owner January 17, 2022 16:48
@welcome
Copy link

welcome bot commented Jan 17, 2022

Thanks for opening this pull request! A contributor should be by to give feedback soon. In the meantime, please check out the contributing guidelines and explore other ways you can get involved.

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.

Confirmed, thank you!

@gr2m gr2m changed the title fix token auth in example docs(development): fix ProbotOctokit usage example Jan 17, 2022
@gr2m gr2m enabled auto-merge (squash) January 17, 2022 19:07
@gr2m gr2m merged commit ec92db2 into probot:master Jan 18, 2022
@welcome
Copy link

welcome bot commented Jan 18, 2022

Thanks for your contribution to probot! 🎉
Congrats!

@github-actions
Copy link

🎉 This PR is included in version 12.2.1 🎉

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants