Skip to content

Sends an email to the open-source contributor with an attachment of Processed and congratulating the avatar image of the contributor.

License

Notifications You must be signed in to change notification settings

Pratham31/AdmireME

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Admire Me - Action which will encourage you to do more open source contribution.


Motivation -

>> Do something today that your future self will thank you for.
>> Little things make big days.

Reason for developing this GitHub Action -

You know when you admire someone, something gets happened and the human being feels so motivated and gets Positive vibes for self and starts the day with POSITIVE ENERGY. I just want each and every one student must contribute to open source and must be satisfied. My Action helps to get a smile 😊 on each and every Open Source Contributors and also encourages for contributing.

What does it do? 🤔

It will send an Email with Processed Congratulating Image of user's avatar and congratulating Note GIF . Check out official Document of GitHub Action from GitHub.

Aim and Impact 💥

This action will ENCOURAGE all future open source contributors to do more and more open source contributions and build positive vibes inside contributors

How to test it? 🤔

Note:

You have to make your Email ID PUBLIC so that action can easily send mail to User. You can make your Email ID public just by going into settings->Emails->Keep my email addresses private and Uncheck the Keep my email addresses private option.

  1. You just have to open a new issue on this AdmireME Repo.
  2. then You'll receive a email with processed your GitHub Avatar attachment.

Wanna use it in your repo? 🤩

  1. Clone the repository.
  2. Copy the all repository contents to your repository where you want to add the Admire ME.


Lets see how I made this Action ❔


1. First of all Setup an Email Sending Account 📧

  1. I Created a new gmail account for sending the emails to the Contributors.
  2. Then you have to authorize Gmail to send the automated emails via this https://myaccount.google.com/lesssecureapps

  1. And in the end create a Github Secret Called GKEY and add your gmail password to it.

2. Setting up the action in your Repository ⚡

  1. Make sure that your repository contains all the necessary files which are present in this repository.
  2. Click on the Actions tab and then create an action.
  3. Add code in Admire.yml to your workflow yml file.

3. Modify Email Contents 📝

  • You just have to Replace the sender_mailID in AdmireME.py file with your newly created email address
  • And then replace the msg['From'] with your email name.
  • that's it!!!!

Trigger Conditions?

  • Trigger Conditions which are used by me in this action are:
on:
  issues:
    types: opened
  pull_request_target:
    types: opened
    branches:
      - master
  • The default triggering conditions are -
  1. Issues - Opened
  2. Pull Request - Opened

Refer the official document from GitHub on Workflow Syntax.

How it looks like?


About

Sends an email to the open-source contributor with an attachment of Processed and congratulating the avatar image of the contributor.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages