search

octokit / octokit.net

A GitHub API client library for .NET
https://octokitnet.readthedocs.io/en/latest/
MIT License
2.69k stars 1.08k forks source link

A release to match the documentation #1815

Closed crhairr closed 6 years ago

crhairr commented 6 years ago

The latest documentation includes mentions of recently implemented support for GitHubApps, however the latest release doesn't have these features. This is very confusing. Either roll back the docs, or put out a new release. I vote for the latter.

ryangribble commented 6 years ago

sorry @crhairr , I didn't fully tweak to the fact that the docs site auto publishes from master whilst the nuget releases are only when I decide to cut a release...

I've been falling into the trap of "just waiting for that one last PR to be done" before cutting a release, but it's no excuse 😭

I'll look to publish one over the weekend!

crhairr commented 6 years ago

I didn't mean to come off so pushy! I actually really like Octokit, and I was just hoping to use the GitHubApps features that were in the docs. Poking around the repo, I could see lots of good stuff, and the code looks to be in great shape, so I couldn't see a reason not to publish.

Thanks for a great tool!

ryangribble commented 6 years ago

All good, I need to release more frequently, particularly when there are doc changes that get auto published from master...

I've pushed out a release, please give our GitHub App support a go, and provide any feedback!

crhairr commented 6 years ago

I just swapped out my code for handling the GitHub installation auth token generation for Octokit's and it works like a charm. Thanks!

ryangribble commented 6 years ago

Awesome! What method are you using to do the JWT creation out of interest?

crhairr commented 6 years ago

We are signing the IntegrationId using the pem-formatted private key generated by GitHub. It would be awesome if the complete JWT signature functionality was included in your API, but I can see why you might leave that part up to the user.

ryangribble commented 6 years ago

the fact we target netstandard1.1 meant we couldn't easily pull in the crypto stuff necessary, but we did refer people to use the GitHubJwt library (and we infact use this in our integration tests as well).

Are you using a particular nuget package to do the JWT or just the crypto code in your app itself? I'd also love to know details on what you're building as it'd be great to know what users we are catering to. If it's not open source, feel free to DM me on twitter

crhairr commented 6 years ago

We're using Org.BouncyCastle.Crypto for reading the PEM file and converting it into a valid key, and Microsoft.IdentityModel.Tokens for handling the JWT library. These are available in .NET Core 1.0.