Discussion on: How To Create A GitHub Profile README

[James George]

I've built a GitHub Action that updates README with the recent activity of a user.

jamesgeorge007 / github-activity-readme

Updates README with the recent GitHub activity of a user

GitHub Activity in Readme

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

---

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.

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

• IssueEvent
• IssueCommentEvent
• PullRequestEvent

You can find an example here.

Custom commit message

Specify a custom commit message with the COMMIT_MSG…

View on GitHub