https://github.com/gregavrbancic/gh-workflow-bot

GitHub workflow bot, triggering workflows when instructed to.
https://github.com/gregavrbancic/gh-workflow-bot

github github-actions github-bot probot-app workflow

Last synced: 2 months ago
JSON representation

GitHub workflow bot, triggering workflows when instructed to.

• Host: GitHub
• URL: https://github.com/gregavrbancic/gh-workflow-bot
• Owner: GregaVrbancic
• License: isc
• Created: 2020-07-24T08:11:55.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-27T08:59:11.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T23:06:41.029Z (2 months ago)
• Topics: github, github-actions, github-bot, probot-app, workflow
• Language: JavaScript
• Homepage:
• Size: 202 KB
• Stars: 3
• Watchers: 2
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  



# GitHub Workflow Bot

![Test](https://github.com/GregaVrbancic/gh-workflow-bot/workflows/Test/badge.svg)

[![codecov](https://codecov.io/gh/GregaVrbancic/gh-workflow-bot/branch/master/graph/badge.svg?token=25JD6QCFOE)](https://codecov.io/gh/GregaVrbancic/gh-workflow-bot)

> A GitHub App built with [Probot](https://github.com/probot/probot) that triggers GitHub workflows on command.

## Usage

1. **[Configure the GitHub App](https://github.com/apps/gh-workflow-bot)**

2. **Use it in pull requests:**

![gh-workflow-bot usage](assets/usage.png)

## Deploy your own instance

If you would like to run your own instance of this app, see the [docs for deployment](https://probot.github.io/docs/deployment/).

This app requires these **Permissions & events** for the GitHub App:

- Action - **Read & write**

- Contents - **Read-only**

- Issues - **Read & write**

  - [x] Check the box for **Issue comment** events

- Repository metadata - **Read-only**

- Pull requests - **Read & write**

## Development

1. Create new Github App (look at previous section for needed permissions)

2. Setup .env file with values (see .env.example)

```sh

# Install dependencies

npm install

# Run in dev mode

npm run dev

# Check code

npm run check-lint

# Fix lint problems

npm run fix-lint

# Run tests with coverage

npm run test

# Run test with reload

npm run test:watch

# Run the bot

npm start

```

## Contributing

If you have suggestions for how gh-workflow-bot 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).

## Credits

Business vector created by [freepik](https://www.freepik.com/free-photos-vectors/business)

## License

[ISC](LICENSE) © 2020 Grega Vrbančič