Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/haxzie-xx/gloria-borger

A probot app to help collaborate on new articles and tweets through a GitHub repo
https://github.com/haxzie-xx/gloria-borger

app automation emails github probot

Last synced: 3 days ago
JSON representation

A probot app to help collaborate on new articles and tweets through a GitHub repo

Host: GitHub
URL: https://github.com/haxzie-xx/gloria-borger
Owner: haxzie-xx
License: isc
Created: 2019-04-09T04:13:05.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2019-04-18T04:18:48.000Z (over 5 years ago)
Last Synced: 2024-11-01T08:42:26.677Z (about 2 months ago)
Topics: app, automation, emails, github, probot
Language: JavaScript
Size: 12.7 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Gloria Borger :woman_technologist:

> A GitHub App built with [Probot](https://github.com/probot/probot) that helps to collaborate and automate sending emails and tweets through GitHub repo

## Setup
- Clone the repo into your local machine
- Copy the `.env.example` in the project directory to `.env` and update the values
- Install all the dependencies `npm install`
- Start the Bot `npm start`
- If you are running for the first time, make sure to visit the localhost webpage run by the app and install it in your repositories

### Repository setup
For Gloria Borger to work on your repository, make sure the repository has a `news-room.yml` file inside `.github` folder in your project.
- create the `news-room.yml` file inside `.github` sub directory
- copy the following contents into the file
```
email_recipients:
group_name_1:
- [email protected]
- [email protected]
group_name_2:
- [email protected]
- [email protected]
admins:
- adminUsername1
- adminUsername2
```
change the group_name.. to your desired group name and add valid email addressess under them, this group name will be used to send mails. Add the usernames of all the admins who will be able to use the bot in the repository.

### Usage

Comment the following commands in any Issue or PullRequest to mail the body of the issue/pull request to the specified email

#### All the Issue/PR should have an approved label before sending mails

#### 1. Approving the ISSUE/PR
```
/approve
```
![Screenshot_2019-04-18 so-sc news-room](https://user-images.githubusercontent.com/18684321/56336491-47ee7080-61be-11e9-8657-f44f7b55ea48.png)

#### 2. Sending mail to an email group
Make sure the email group is defined inside the `news-room.yml` file under `email_recipients`
```
/mail to [EMAIL_GROUP_NAME]
```
![Screenshot_2019-04-18 so-sc news-room(1)](https://user-images.githubusercontent.com/18684321/56336515-68b6c600-61be-11e9-8718-af3876af0239.png)

#### 3. Sending mail to a specified email
Gloria Borger will automatically delete the comment containing the email for privacy concerns
```
/mail to [email protected]
```

![Screenshot_2019-04-18 so-sc news-room(2)](https://user-images.githubusercontent.com/18684321/56336553-91d75680-61be-11e9-9f6f-06139eda0fdc.png)

## Contributing

If you have suggestions for how gloria-borger 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