Uh oh!
There was an error while loading. Please reload this page.
make octokit instance available as octokit on top of github, to make it easier to seamlessly copy examples from GitHub rest api or octokit documentations - #508
Conversation
joshmgross
commented
Jan 17, 2025
Thanks for the suggestion @iamstarkov - my one concern with this change is that users may assume |
my two cents would be that I used github-scripts heavily in the last few years and I'd not make that mistake, and also I think javascript developers are grown to know the difference Class and an instance. And my last argument will be that consistency with documentation will lead to net-smaller confusion after all. What do you think? |
joshmgross
commented
Jan 28, 2025
@iamstarkov I'm fine with this change - could we update the documentation as well to make it clear that this is an option? |
iamstarkov
commented
Jan 31, 2025
@joshmgross absolutely |
…it easier to seamless to copy examples from GitHub api or octokit documentation
…Hub still being available
iamstarkov
commented
Jan 31, 2025
@joshmgross updated documentation as we agreed, feel free to take a look |
iamstarkov
commented
Jan 31, 2025
checked out project locally, adjusted types and committed updated dist folder accordingly |
I have off topic to PR question, which i'm curious about GitHub assigned this PR to a team without assigning anyone. is CODEOWNERS correct and @actions/actions-launch exists, but its not public? |
joshmgross
commented
Feb 4, 2025
@iamstarkov yes that is a team, that's not my area of GitHub but my understanding is that organization teams are never public and can only be internal to all organization members or hidden. |
iamstarkov
commented
Feb 4, 2025
how does the release process look like for this action? I noticed 41 unreleased commits since last release |
The update-workflow job has been failing for the last week due to a [breaking change](actions/github-script#508) in the github-script action. fixes#1694, fixes#1697
The update-workflow job has been failing for the last week due to a [breaking change](actions/github-script#508) in the github-script action. I tested this on the single provider update here https://github.com/pulumi/ci-mgmt/actions/runs/17615634066/job/50047844245fixes#1694, fixes#1697

examples on GitHub api documentation use octokit as an octokit instance, so does the octokit documentation itself. its kinda a bummer to always rename when you copy from documentation or from another files.
I understand that octokit was made available over the github keyword, and I dont want to break that, but it won't hurt nobody to expose octokit instance over the octokit keyword as well and it will help people who use documentation a lot
what do you think? if this is something you are up for adding, let me know and I adjust documentation accordingly