rahulraikwar00 / readme-projects-display Goto Github PK

GitHub's Profile readme is a great tool to showcase your skills and projects to potential recruiters/developers. This GitHub action allows you to update a particular section of README with your Project details. These include the project name, stars, and a controllable amount of description.

• Add this comment in your README.md/specified file:

<!-- PROJECTS START -->
<!-- PROJECTS END -->

• The repositories need to have project topic to add them to the project section.

• A GitHub personal access token will be needed which can be obtained by going to Settings > Developer Settings > Personal Access Tokens.

  

Note: If you give personal repositories access then they will be added to the sections but their links will not work for others

GitHub actions can be integrated in any repository. Create a new folder called .github/workflows/<any-name>.yml. Paste the following starter code:

name: Update Projects
on:
  schedule:
    - cron: '0 0 * * *'
    # This makes the action to run at the end of every day. Customize this accordingly or you can also trigger this action for GitHub events (Pull, Push). Check the GitHub actions page for that.
  workflow_dispatch:
    # workflow_dispatch allows you to trigger the action any time manually

jobs:
  update-readme-with-projects:
    name: Update this repo's README with latest project updates
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: kaustubhgupta/readme-projects-display@master
        with:
          gh_token: ${{ secrets.TOKEN }} # Create a secret to store the access token 

• My Workflow File

Happy?? Do Star ⭐ this Repo. 🤩