GitHub GitHub Checkout, 25 Feb 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: GitHub Discussions GraphQL API public beta - GitHub Checkout

Description

The GitHub Discussions GraphQL API public beta is now available.

For questions or feedback, visit GitHub Discussions feedback.

https://github.com/github/feedback/discussions/categories/discussions-feedback

As always, feel free to leave us a comment below and don't forget to subscribe: http://bit.ly/subgithub

Thanks!

Connect with us.
Facebook: http://fb.com/github
Twitter: http://twitter.com/github
LinkedIn: http://linkedin.com/company/github

About GitHub
GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Millions of people use GitHub to build amazing things together. For more info, go to http://github.com

A

Hi, I'm anisha and I've got to get a feature for you to check out.

A

So if you've been following along the github change, log post, you've seen all of the amazing new features that we've been shipping recently, but for these videos we'll be hearing more from the folks that actually built these features and see a working demo of them too. So for this, video we'll be hearing more from evie who'll, be telling us more about the discussions public api, which is currently in beta evie over to you.

B

Thanks anisha so hi, my name is evie and I'm a product manager here at github on github discussions. Discussions is a collaborative communication forum that allows community members to ask and answer questions, share, updates and have open-ended conversations to get started with discussions. Today you can enable discussions under manage features in the repository settings, so today I'm going to be demoing how to use the github discussions graphql api that enables you to get create edit and delete discussion posts.

B

You can use any graphql client for this or any other method you normally use to hit graphql endpoints, but for the purposes of today's demo, I'm going to be using graphyql great so over in graphql, make sure that you have the appropriate headers enabled for github discussions api.

B

So in this case the header name would be graphql dash features and then the header value would be discussions api once that's been added and you hit the appropriate graphql endpoint for github. Then we're ready to start making query requests for discussions so for this first one we're going to do an example of getting the categories for a specific discussions repository so over here. I have my test repository. So that's the name of the repository and I'm also the owner, and so this query is calling for discussion category.

B

So it's getting the first ten and we see here we're getting the name. We can also get the id and let's also get whether or not this is an answerable category. So let's go ahead and hit run and there we go. We see in json format for this particular repository. We have four categories: we've got general, which is a open-ended conversation, so not answerable. We have a q, a which is answerable. We've got the ideas category, which is not answerable and we've got show and tell which is also not answerable.

B

So that was a quick and easy way to just see what categories you have in a certain repository all right and for this next demo, I'm going to be showing how you can get the discussions themselves from a certain repository. So for purposes of this demo, I'm looking at the versailles next.js repository- let's just say we want to get the first 20 discussions from them.

B

So here we're getting the title. We can also see who the author is and whether or not we have an answer chosen at for this particular discussion. So let's go ahead and run that and see what that looks like and there we go again super fast.

B

Obviously, so these are the first 20 discussions that we see in the versailles next.js repository, and these are just the most recent ones that we've seen and you can also see whether or not there's an answer chosen for each of these, and we can see most of these have not had an answer chosen yet, but this one does so super quick and easy way to just get some data on the repositories that you care about with discussions, and for this last example, I'm going to be showing how you can use a create mutation to import data into discussions themselves, so this one is a create mutation for creating discussions to seed your repository with existing content.

B

So in this example, I'm using my test repository, so I previously got this repository id from graphql, endpoints and then category id, which I showed in the first demo, which you can get category information from. So you would fill in the body. So, let's just say, test discussion and then a title which we can say demo for graphql and once that's filled in super simple.

B

Let's go ahead and run it and we see here that this discussion was created and if I actually go into that repository, we'll see that that discussion is live and there and ready to go.

A

So evie I've got a question for you, then what.

B

A

Mutations are available on the discussions graphql api.

B

Yeah, so for the first iteration we have create discussion, update discussion, edit, add discussion, comment, update, discussion, comment and delete discussion comment as well as marking an answer or unmarking his answer. So that's just the first iteration that we have available. But if you have other mutations that you'd like to see, let us know in the feedback and we'll add them.

A

On great so now that the graphql api is available, are we going to have discussions webhooks as well.

B

Oh great question: so yes, we've definitely heard feedback from many maintainers and communities that web hooks would be super valuable to have on discussions as well. So I can tell you this: our team is currently hard at work at implementing webhooks, so stay tuned and you'll see them soon.

A

Perfect thanks evie, so go ahead and check out this new feature, and let us know what you think about it as well as any other feature that we've shipped recently as well, and if you like. These videos, go ahead and subscribe and you'll see more checkout videos coming your way very soon.