loading...
Cover image for Thanks Action- A Github Action to Automate Your Readme and generate Wall Of Honour.

Thanks Action- A Github Action to Automate Your Readme and generate Wall Of Honour.

hemant profile image Hemant Joshi ๐Ÿ˜ผ ใƒป3 min read

Hii, Everyone this is the Submission post for ActionsHackathon, hosted on Dev.to.

My Workflow

Hii,

Recently Github announced Actions Hackathon hosted on Dev.to, where one can build Actions and check-in for Winning the Hackathon, and here is from from the Thanks-Action for Birth.

What is Thanks-Action?

Lets Roll in, Thanks-Action is a GitHub action, build with Javascript and โค๏ธ, the simple aim of the Thanks-Action is to Paint a Wall of Honour of all the Open Source Contributors for a Repository/Project in a matter of second. A beautiful Thank Message is too showed, the Action is Automated and can be made Default On Push, On Pull or Both.

The Wall Of Honour

Wall of Honour is a simple but powerfully printed in your Root README.md, displaying a list of all the contributors with a simple Thank Message, just to Thank and inspire Developers To Open-Source.

What is Open-Source?

If you are a Developer/ Content Writer or Any in any of the Profession, you can Contribute to your wish project with a piece of code, image, art etc.

Open Source helped a lot of Projects to change and advance performance within less time, and have real-time user experience and capture real-time issues.

Some of the Great Projects

  • React JS
  • Visual Studio Code
  • Bootstrap
  • TensorFlow
  • Axios
  • Angular

Also, one of my Favourite:

  • Dev.to

How it Started

I have been contributing in Open Source from a long time and the Reason to Built Thank-Action after a long time Begins with my Recent Project to Generate your Dev-Blogs, using Dev.to API, Javascript and React.

Here is the preview: https://hemant-blogs.netlify.app
where some people contributed, and made this project happen and Amazing.

So, I wanted to Thank the Contributors and let other people to contribute and embed them in the Honour Of Wall, here is the preview for Dev-Blogs Contributor's wall.

Alt Text

Currently there are total 3 contributors, but It supports up to 500 contributors, and a beautiful Thank You Message.

Source Code

If you want to Contribute to the Code and Make the Open Sourcing fun, below is the link to Github Repo:

GitHub logo 8bithemant / Thank-Action

Open-source Project management action and a Maintainer Must-Have Action.

Automate Your README to Honour Contributors.

heart


Thank You for being a open source contributor, we do appreciate your efforts for making Open Source Awesome.

Made With and

Initial Setup:

  • Create a new Folder .github in your root directory

  • Create a Empty folder workflows inside .github folder

  • Final ๐ŸŽ‰

    • Create a new file action.yml

The new structure will look like:

.github/workflows/action.yml

The final step of initialization is add the following code to

action.yml

    on: [push, pull_request]
    jobs
         contrib-readme-job
         runs-on: ubuntu-latest
     name: Target README.md
     steps:
         - name: Github Action Contributor
           uses: 8bithemant/Thank-Action@v.03
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

LICENSE


Thank You All Contributing and Making The Source Open ๐ŸŒ .

๐ŸŽ‰ We did love to see more commits and raised issues by you allโ€ฆ

Repo Using Thank Action

Here is one my latest Project, using the Thank-Action to support and motivate to Contribute.

GitHub logo 8bithemant / Dev-Blogs

Hii, This is a blog Designed in React-Js, with Javascript and Love. App Fetches Your Blogs from Dev.to using Dev.to Api

Note

If you are too using or have decided to use Thank-Action, would love to see you and you can add yourself in the Above Section, Comment Below or Dm for the Updates.

I would love to see you using the Thank Action.

Thank You

Submission Category:

I wanted to Submit Thank Action under the following Categories.

  • Maintainer Must-Haves
  • DIY Deployments

Yaml File or Link to Code

To Generate or use the Thank-Action all you need to do is

Create the following folder structure in your Github Repository Root:

.github/workflows/main.yml

That's it, now you need the add the action code to Begin the Automation of Readme.

Below is the code, which you can add to your readme and Automate the Readme With Thank-Action.

    on: [push, pull_request]

    jobs:
         contrib-readme-job:
         runs-on: ubuntu-latest
     name: Target README.md
     steps:
         - name: Github Action Contributor
           uses: 8bithemant/Thank-Action@.03.02
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Can update the
on for push or pull_request.

Additional Resources / Info

Open source project using the workflow!

Special โค๏ธ Thanks To GitHub and Dev.to Team.

๐ŸŽ‰Happy ๐ŸŽŠOpen๐ŸŽŠ Sourcing๐ŸŽ‰

End

Would love to see you using Thank Action, just comment below with your link to Repo including Thank Action๐Ÿ˜.

Thanks A Lot For Read!

Posted on by:

Discussion

pic
Editor guide
 

Great idea!

How do you decide where the "Thanks" wall is added within the readme? Maybe you could target for a ___THANKS_WALL_START___ and end to replace what's inside by the new generated version? This way, it gives more flexibility as to where the wall is shown (bottom being a good default).

Also, it would be great to be able to customise the message ourselves, instead of it being hardcoded. ;)

 

Yup, lately I have been so busy with personal projects and aim to update the Thank Action with custom location and few more updates.

Currently, the Readme's bottom is targetted.

I Will bring up the updates soon asa I get done with some important tods.

Thanks a lot Vadorequest.

 

This is Cooooool๐Ÿ™†โ€โ™‚๏ธ