Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/camunda-community-hub/camunda-community-hub-probot

The Camunda Community Hub Probot Application
https://github.com/camunda-community-hub/camunda-community-hub-probot

javascript probot probot-app

Last synced: about 1 month ago
JSON representation

The Camunda Community Hub Probot Application

Awesome Lists containing this project

README 

        
 [![Community Extension](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community) 



# Camunda Community Hub Probot



## The Camunda Community Hub Probot allows you to quickly add labels to issues by commenting and typing a slash command, allows for maintainers to opt-in to automated release note drafting, and automatically applies a triage label to open issues or pull requests without any labels specified. 



### Issue Labeling with Probot:



To add a label to an open issue or pull request, in the 'Leave a Comment' space enter the following:



```

/lm add label1, label2, label3

```



Once your comment is posted, after a few moments, the bot should apply the label you specified. To see the list of labels available to you in the Camunda Community Hub, please review our [steps for issue triage and labelling](https://github.com/camunda-community-hub/community/blob/main/issue-triage.md). For more information on extension lifecycles and how to implement them, please [read the documentation](https://github.com/camunda-community-hub/community/blob/main/extension-lifecycle.md).



### Issue Triage 



If you open an issue without a label, Probot will automatically assign the 'triage' label to your issue. Once an issue label is added, the triage label will be removed. If your issue has labels applied to it before submitting the issue, the 'triage' label will not be applied.



### Automated Release Notes Drafting



If you would like to opt-in to using [Release Drafter](https://github.com/release-drafter/release-drafter) to automate drafting of your extension's release notes, you can do so by doing the following:



1. [Set a topic](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics) in your repository to release-drafter.

2. Add a label to an issue or PR that adheres to the Release Drafter specifications. These are feature, fix, and chore

3. Once one of the above labels is added, the corresponding GitHub Action will run. When successful, you can click on 'Details' in the workflow to see the checks complete, or to debug any issues that arise.






To learn more about Release Drafter, we suggest [reading the official documentation](https://github.com/release-drafter/release-drafter).



4. Currently, if a check fails, it must be re-run manually. We hope to automate this in the future.

5. If you have no labels on a PR and you choose to merge it, it will not be included in the automated release notes.



### Troubleshooting



If you are running into issues with Probot, please [open an issue](https://github.com/camunda-community-hub/camunda-community-hub-probot/issues). If you see a bug, or something that you would like to fix or contribute to, please [open a pull request](https://github.com/camunda-community-hub/camunda-community-hub-probot/pulls) after reviewing our [contribution guidelines](https://github.com/camunda-community-hub/camunda-community-hub-probot/blob/main/CONTRIBUTING.md).



If a label is incorrectly applied, you can remove it by typing /lm remove along with the [name of the label](https://github.com/camunda-community-hub/camunda-community-hub-probot/labels)



### Setup



```sh

# Install dependencies

npm install



# Run the bot

npm start

```



### Docker



```sh

# 1. Build container

docker build -t camunda-community-hub-probot .



# 2. Start container

docker run -e APP_ID= -e PRIVATE_KEY= camunda-community-hub-probot

```



## Debug logging



Set the environment variable `OCTOKIT_DEBUG=TRUE` to turn on debug logging for octokit.



Set `DEBUG_LOG_REQUESTS=TRUE` to log out all incoming webhook requests.



### Contributing



If you have suggestions for how camunda-community-hub-probot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.



For more, check out the [Contributing Guide](CONTRIBUTING.md).



### License



[ISC](LICENSE) © 2021 Rin (they/them)  & [@jwulf](https://github.com/jwulf).



> A Legendary GitHub App built with [Probot](https://github.com/probot/probot)