DEV Community

loading...

First Github Action and First Post!

tryonlinux profile image Jordan Tryon ・1 min read

So this is my first time posting on Dev.to, been a reader and lurker...

I really love the fact that Dev.to had the hackathon as I probably would have not tried github actions for quite sometime nor would I have built one anytime in the near future, but I learned quite a bit with this hackathon and now know how powerful and useful they are and probably will use them in my personal and business projects.

I will say the learning curve was a bit to wrap my head around, but once I figured out how the whole steps in the .yml action file went, and how to set secrets in github it went way faster.

GitHub logo tryonlinux / email-readme-on-change-action

Action to email you the Readme.md File on change during a push

email-readme-on-change-action

Your readme is probably the most important part of your project, it is the first thing people see when they visit your repo. You probably should check it out when someone or yourself makes changes. This action is for that, it will send an email with the readme content on a push change to an email you specify.

I created this action to learn as part of the dev.to github action hackathon. Feedback is welcomed as it was my first attempt.

Inputs

Nothing

Outputs

Nothing

Example usage

uses: tryonlinux/email-readme-on-change-action@master

Make sure you set the sendgrid api secret for the repo under Settings > Secrets > SENDGRID_API_KEY as well as REPO_EMAIL_ADDRESS

Once those are set, if you or someone else updates the readme file and pushes it to the repo, an email will be sent to the email listed in REPO_EMAIL_ADDRESS with an markdown to html conversion in the body…

I defiantly welcome any feedback, as this was my first try and I only spent like half a day on it.

Discussion (0)

pic
Editor guide