Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jamesgeorge007/github-activity-readme

Updates README with the recent GitHub activity of a user
https://github.com/jamesgeorge007/github-activity-readme

activity github-action github-action-javascript github-actions github-workflow hacktoberfest hacktoberfest2020 javascript profile-page profile-readme readme readme-template

Last synced: 4 days ago
JSON representation

Updates README with the recent GitHub activity of a user

Awesome Lists containing this project

README 

        
# GitHub Activity in Readme



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



profile-repo



---



## Instructions



- Add the comment `` (entry point) within `README.md`. You can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/README.md).



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



`.github/workflows/update-readme.yml`



```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](https://jasonet.co/posts/scheduled-actions/#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](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/.github/workflows/update-readme.yml).



### 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`       | :zap: Update README with the recent activity                             | Commit message used while committing to the repo          |

| `EMPTY_COMMIT_MSG` | :memo: 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                   |



```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 }}

        with:

          COMMIT_MSG: "Specify a custom commit message"

          MAX_LINES: 10

          COMMIT_NAME: GitHub Activity Readme

```



_Inspired by [JasonEtco/activity-box](https://github.com/JasonEtco/activity-box)_