Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/TimonVS/epic-generator

GitHub bot that facilitates in creating epics
https://github.com/TimonVS/epic-generator

github-app github-integration probot probot-app

Last synced: 3 months ago
JSON representation

GitHub bot that facilitates in creating epics

Host: GitHub
URL: https://github.com/TimonVS/epic-generator
Owner: TimonVS
License: isc
Created: 2018-10-05T10:37:54.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2018-10-09T07:58:36.000Z (about 6 years ago)
Last Synced: 2024-07-27T08:32:57.054Z (4 months ago)
Topics: github-app, github-integration, probot, probot-app
Language: TypeScript
Homepage:
Size: 762 KB
Stars: 7
Watchers: 3
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Epic Generator

A GitHub bot that facilitates in creating epics.

![Demo](./doc/demo.gif)

## Usage

1. [Configure the GitHub App](https://github.com/apps/epic-generator), make sure to install it for select repositories and not for a whole organization.
2. Create a label with the name "epic".
3. Create or edit an issue and add any issues that are part of the epic by adding an HTML comment to the description of the issue like so: ``, add as many issues as you like.
4. Add the "epic" label to the issue
5. Submit the issue and refresh after a couple of seconds and the table should show up.

### Updating an epic

To add or remove issues from the epic simply edit the issue and add or remove issues between ``.

## Caveats

When you close or otherwise update an issue that's part of an epic, the changes will not be reflected in the epic yet. Instead one has to update the epic (for example by adding a blank line) to make the table up-to-date.

## Development setup

```sh
# Install dependencies
yarn

# Run typescript
yarn build:watch

# Run the bot
yarn dev
```

See the [Probot deployment docs](https://probot.github.io/docs/deployment/) if you would like to run your own instance of this plugin.

## Contributing

If you have suggestions for how Epic Generator 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