Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
activity

GitHub Action

GitHub - Activity - Readme

v0.2.0

GitHub - Activity - Readme

activity

GitHub - Activity - Readme

Updates README with the recent GitHub activity of a user

Installation

Copy and paste the following snippet into your .yml file.

              

- name: GitHub - Activity - Readme

uses: jamesgeorge007/github-activity-readme@v0.2.0

Learn more about this action in jamesgeorge007/github-activity-readme

Choose a version

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.

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

  • IssueEvent
  • IssueCommentEvent
  • PullRequestEvent

You can find an example here.

Inspired by JasonEtco/activity-box