/github-activity-readme

Updates README with the recent GitHub activity of a user

Primary LanguageJavaScriptMIT LicenseMIT

UPDATE

This repo is now maintained at Readme-Worklows/recent-activity

GitHub Activity in Readme

Note: This project is a fork of https://github.com/jamesgeorge007/github-activity-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: Readme-Workflows/recent-activity@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.

Override defaults

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

Input Param Default Value Description
COMMIT_MSG ⚡ Update README with the recent activity Commit message used while committing to the repo
MAX_LINES 5 The maximum number of lines populated in your readme file
README_FILE ./README.md The readme file you want to push your activity to 
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: Readme-Workflows/recent-activity@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          COMMIT_MSG: "Specify a custom commit message"
          MAX_LINES: 10

History

  • The original project was inspired by JasonEtco/activity-box
  • Puneet and Abhishek wanted to add a new feature, the original project was no longer maintained, so Puneet created a fork and Abhishek supported him.