- Notifications
You must be signed in to change notification settings - Fork0
My fork of jamesgeorge007/github-activity-readme. Updates README with the recent GitHub activity of a user. I added Create and Push Event support
License
aleguy02/github-activity-readme
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
UpdatesREADME.md with the recent GitHub activity of a user. Forked from jamesgeorge007/github-activity-readme.
Add the comment
<!--START_SECTION:activity-->(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@v3 -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:-
IssueEventReleaseEventIssueCommentEventPullRequestEventPushEventCreateEvent
You can find an examplehere.
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@v3 -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
Inspired byJasonEtco/activity-box
About
My fork of jamesgeorge007/github-activity-readme. Updates README with the recent GitHub activity of a user. I added Create and Push Event support
Topics
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Languages
- JavaScript100.0%