GitHub Activity in Readme

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

Instructions

Add the comment  (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:
    name: Update this repo's README with recent activity
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v3
      - 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.

Please note that only those public events that belong to the following list show up:-

IssueEvent
ReleaseEvent
IssueCommentEvent
PullRequestEvent

You can find an example here.

Override defaults

Use the following input params to customize it for your use case:-

Input Param	Default Value	Description
`GH_USERNAME`	Your GitHub username	Username for which to generate the activity overview
`COMMIT_NAME`	github-actions[bot]	Name of the committer
`COMMIT_EMAIL`	41898282+github-actions[bot]@users.noreply.github.com	Email of the committer
`COMMIT_MSG`	⚡ Update README with the recent activity	Commit message used while committing to the repo
`EMPTY_COMMIT_MSG`	📝 empty commit to keep workflow active after 60 days of no activity	Commit message used when there are no updates
`MAX_LINES`	5	The maximum number of lines populated in your readme file
`TARGET_FILE`	README.md	The file to insert recent activity into

name: Update README
on:
  schedule:
    - cron: "*/30 * * * *"
  workflow_dispatch:
jobs:
  build:
    name: Update this repo's README with recent activity
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v3
      - uses: jamesgeorge007/github-activity-readme@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          COMMIT_MSG: "Specify a custom commit message"
          MAX_LINES: 10
          COMMIT_NAME: GitHub Activity Readme

Inspired by JasonEtco/activity-box

License

iloveryuux/github-activity-readme

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages