jamesgeorge007/github-activity-readmePublic

NotificationsYou must be signed in to change notification settings
Fork232
Star883

Updates README with the recent GitHub activity of a user

License

MIT license

883 stars 232 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Use this GitHub action with your project

Add this Action to an existing workflow or create a new one

View on Marketplace

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 64 Commits
.github/workflows		.github/workflows
dist		dist
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
action.yml		action.yml
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json

Repository files navigation

GitHub Activity in Readme

UpdatesREADME.md with the recent GitHub activity of a user.

Instructions

Add the comment (entry point) withinREADME.md. You can find an examplehere.
It's the time to create a workflow file.

.github/workflows/update-readme.yml

name:Update READMEon:schedule:    -cron:"*/30 * * * *"workflow_dispatch:jobs:build:name:Update this repo's README with recent activityruns-on:ubuntu-latestpermissions:contents:writesteps:      -uses:actions/checkout@v4      -uses:jamesgeorge007/github-activity-readme@masterenv:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}

The above job runs every half an hour, you can change it as you wish based on thecron syntax.

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

IssueEvent
ReleaseEvent
IssueCommentEvent
PullRequestEvent

You can find an examplehere.

Override defaults

Use the followinginput 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 READMEon:schedule:    -cron:"*/30 * * * *"workflow_dispatch:jobs:build:name:Update this repo's README with recent activityruns-on:ubuntu-latestpermissions:contents:writesteps:      -uses:actions/checkout@v4      -uses:jamesgeorge007/github-activity-readme@masterenv:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}with:COMMIT_MSG:"Specify a custom commit message"MAX_LINES:10COMMIT_NAME:GitHub Activity Readme