Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvement #124

Open
RedNeath opened this issue Apr 19, 2024 · 5 comments
Open

Documentation improvement #124

RedNeath opened this issue Apr 19, 2024 · 5 comments

Comments

@RedNeath
Copy link

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
Copy link

@RedNeath Have you figured out how to use tags?

@RedNeath
Copy link
Author

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:
LaPesteModerne/.github#32

@holmityd
Copy link
Owner

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
Copy link
Owner

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants