[nodebb-plugin-github-embed] GitHub Issue Embedding

<baris>

Wouldn't it make sense to replace gh#123 with the rendered output instead of adding it to the end like other markdown stuff?

julian

It's mostly a aesthetic choice. I'm not a fan of plugins that replace certain keywords with an inline object (take for example, youtube videos). That example is less of a problem, but I like being able to reference an issue in the middle of a sentence... a la:

Take a look at gh#256, that's where we solved that bug

^ No interruption of flow, and the referenced issue is at the bottom for you to check out if you want.

psychobunny

I'll disagree with both of you and suggest that the output be a popup similar to @Schamper's plugin. On mobile, just links to the actual issue. When I mention gh#123 it should be a link, at the very least. Just some ideas

EDIT: Scratch all of the above, you guys just gave me a great idea for a hook. Will get back to this later

a_5mith

@psychobunny reading the title of the issue you used in your example took 4 attempts to make any sense... kept thinking I was reading words over and over again like a child that reads the same line twice.

julian

Hahah wow @psychobunny actually fixed gh#123? I don't even need it anymore, but it's a nice thing to have

psychobunny

@a_5mith said:

@psychobunny reading the title of the issue you used in your example took 4 attempts to make any sense... kept thinking I was reading words over and over again like a child that reads the same line twice.

And the best part?

I don't even need it anymore

Mandosis

@julian Is it possible to update this plugin to work with private repositories? I have a private forum for a group of developers I am working with to create and indie game and it would great to be able to use this but our repo must be private for obvious reasons.

julian

Hi @Chris-Rabuse -- private repositories are hidden behind secure API endpoints that require a client ID and secret to access. You can generate one tied to your account in the GitHub account settings. I use my personal GitHub account, but I believe an organization works too.

It looks something like this:

If you register for an id/secret pair and put it into the GitHub Embed settings, it should allow the plugin to read/show private issues.

Keep in mind that this also means unprivileged users on your forum could also use the short codes to retrieve private issue data, so caveat emptor

Mandosis

@julian Fantastic! Thanks for the help!

Edit: I cant seem to be able to get this to work. Is it because I dont have a callback URL or that I am not the owner of the repo?

julian

@Chris-Rabuse The use of the id/secret was originally added to raise the limit for GitHub calls. I'm guessing it doesn't work to find private repos

Give me a moment to check...

Mandosis

@julian Would a personal access token work?

julian

@Chris-Rabuse said:

@julian Would a personal access token work?

Yes, though the plugin doesn't support it yet. Will push a new version shortly.

julian

@Chris-Rabuse julianlam/nodebb-plugin-github-embed#7

Done v0.2.2

Mandosis

@julian This works perfectly! Thank you!

julian

Updated the plugin, still working fine on v0.6.x and v0.7.x

julian

Updated the plugin again. Now you can reference commit hashes!

https://github.com/julianlam/nodebb-plugin-github-embed/commit/8c49fc34122fce78d53b3d2f6a649dfd7e2149a7

a_5mith

@julian said:

Updated the plugin again. Now you can reference commit hashes!

https://github.com/julianlam/nodebb-plugin-github-embed/commit/8c49fc34122fce78d53b3d2f6a649dfd7e2149a7

Just don't try clicking and dragging the scroll bar.

julian

scrollbar?

a_5mith

Yeah the.. oh you fixed it. Now I look silly.

katana

@julian Thought wrt usability of the keyword replacement and refusal to do thereof (ref post #18) - why not take a step similar to how wikis go and tack on a footnote link which would link to the appropriate segment at the bottom of the post.

ex "gh01234" -> "gh01234 [1]"

Best of both worlds. Users can find the actual embed they want to see info for, and you don't get weird voodoo going on.

Also hi.