search

holmityd / GitHub-Issues-Discord-Threads-Bot

Effortlessly manage, track, and synchronize discussions in Discord with issue tracking on GitHub for streamlined collaboration.
25 stars 7 forks source link

Documentation improvement #124

Open RedNeath opened 6 months ago

RedNeath commented 6 months ago

Hey!

I like your job 👍 However, when I tried using this bot, I struggled a little bit when setting the personnal access token up.

I tried opening a pull request with an update on the main README file, but I wasn't allowed to do it, so I figured I could tell you about it in this isssue.

This is what I wanted to add in the README (at the end of the env section):

> **NOTE:**  
> As the bot uses the GitHub API, the Personnal Access Token (or PAS) will have to be "Fine-grained".
>
> Also, make sure you let the token have administrator rights on the repo you want to set the bot up on, otherwise the deletion of a forum post will cause it to crash.

Which outputs as:

NOTE:
As the bot uses the GitHub API, the Personnal Access Token (or PAS) will have to be "Fine-grained".

Also, make sure you let the token have administrator rights on the repo you want to set the bot up on, otherwise the deletion of a forum post will cause it to crash.

Related to the addition in the README, do you plan to catch exceptions on calls to GitHub or Discord APIs (at least in production mode), so that it doesn't necessarily crash when a request fails?
If you need help for that, I'd be glad to take part in the development process 😃

thierbig commented 5 months ago

@RedNeath Have you figured out how to use tags?

RedNeath commented 5 months ago

Labels seems to work, the bot just takes the name of the tag you apply to the forum post on discord.

The emoji is not reinserted though, and I haven't tested modifying it on discord to see if it changes in the issue top 🤷‍♂️

My example: https://github.com/NeiagariCinematicUniverse/.github/issues/32

holmityd commented 5 months ago

Hey!

Thanks for the feedback! I've updated the README with your suggestions. Regarding exceptions, i'll look into handling those API call failures better. For the production build, will use Webpack build so it can run a single script file without needing dependencies.

holmityd commented 5 months ago

Labels are automatically generated from Discord tags, but unfortunately, they only include the name part without the emoji. Additionally, they don't refresh after the label/tag name is updated.

thierbig commented 5 months ago

Awesome thank you! Are you still actively dev'ving on the project?