https://github.com/theshubham99/yourock
Sends an email to the contributor with an open-cv processed personalized avatar image of the contributor.
https://github.com/theshubham99/yourock
github github-actions
Last synced: about 1 year ago
JSON representation
Sends an email to the contributor with an open-cv processed personalized avatar image of the contributor.
- Host: GitHub
- URL: https://github.com/theshubham99/yourock
- Owner: TheShubham99
- License: mit
- Created: 2020-08-16T15:14:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-28T08:02:03.000Z (about 4 years ago)
- Last Synced: 2025-05-04T11:05:13.695Z (about 1 year ago)
- Topics: github, github-actions
- Language: Python
- Homepage:
- Size: 15.2 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
You Rock - A Personalized Contribution Appreciator.
[](https://opensource.org/licenses/MIT)
# What it does?
Sends out a personalized email appreciating the contribution with some **Badges** and **Image Processed Personalized Material**.
# Aim and Impact
This action will help :hash: **maintainers** to improve the `outreach` and Public Relations.
# What it looks like?
# How to test?
1. Just open a new issue on this [YouRock](https://github.com/TheShubham99/YouRock) Repo.
2. You'll receive a personalized email (email account linked to your **Github**)
# How to use it in your repo?
1. Clone the repository.
2. Copy the repository contents to your repository where you wish to add the **You Rock - Appreciator**.
## Setup Email Sending Account
1. Create a new gmail account for sending the emails.
2. Authorize Gmail to send automated emails via this tool https://myaccount.google.com/lesssecureapps
3. Create a [Github Secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) Called `GKEY` and add your gmail password to it.
4. Unlock the captcha link on sender account: https://accounts.google.com/DisplayUnlockCaptcha
## Setting up the action
1. Make sure your repository contains all the necessary files present in this repository.
2. Click on Actions and `create an action`.
3. Add code in `Appreciate.yml` to your workflow `yml` file.
## Customize your email contents
1. - Replace the `senders_email` in `Rock.py` with your newly created `email address` (on line 65)
- Replace the `msg['From']` value with your email display name.
2. You can change the `glasses.png` with your Mask image. (make sure you rename it back to `glasses.png`)
3. You can change the `gold.png` with your Mask image. (make sure you rename it back to `gold.png`)
### Note:
- If you changed the file name of `glasses.png` and `gold.png` make sure to reflect in your `workflow`/`.yml`.
- The `glasses.png` will get placed on users face (in github avatar) and It will be sent only if there is a face in the users github avatar.
## How to change the contribution triggers?
you can edit the `Appreciate.yml` by changing the triggering conditions.
```
on:
issues:
types: opened
pull_request:
types: opened
branches:
- master
```
The default triggering conditions are -
1. Issues - Opened
2. Pull Request - Opened
You can change the job triggers according to your need.
[Learn More about the syntax for actions here.](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions)
# Drop a ⭐ if you like it :)