Skip to content

A GitHub action to automatically update your profile README with all of your recent GitHub activity, including commits, PRs, issues, and more!

License

Notifications You must be signed in to change notification settings

nikosdaridis/github-activity-readme

 
 

Repository files navigation

GitHub Activity in Readme

Updates README.md with the recent GitHub activity of a user.

profile-repo


Instructions

  • Add the comment <!--START_SECTION:activity--> (entry point) within README.md. You can find an example here.

  • It's the time to create a workflow file.

.github/workflows/update-readme.yml

name: Update README

on:
  schedule:
    - cron: '*/30 * * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update this repo's README with recent activity

    steps:
      - uses: actions/checkout@v2
      - uses: jamesgeorge007/github-activity-readme@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The above job runs every half an hour, you can change it as you wish based on the cron syntax.

You can find an example here.

Inspired by JasonEtco/activity-box

About

A GitHub action to automatically update your profile README with all of your recent GitHub activity, including commits, PRs, issues, and more!

Resources

License

Code of conduct

Stars

Watchers

Forks