thedannicraft/activity-log

A GitHub Action that automatically updates your README file with the latest activity from your GitHub account. Customize the displayed events, set a limit on the number of events, and ignore specific event types. Ideal for keeping your personal README file current with recent contributions and changes.

Activity Log

A GitHub Action that automatically updates your README file with the latest activity from your GitHub account. Customize the displayed events, set a limit on the number of events, and ignore specific event types. Ideal for keeping your personal README file current with recent contributions and changes.

🛠️Features

• Customizable Event Limits
• Event Filtering
• Flexibility with Inputs

✍️ Example

1. 🚀 Created a new tag v1 in TheDanniCraft/activity-log
2. 🗑️ Deleted a tag v1 in TheDanniCraft/activity-log
3. 📦 Published release v1.0.1 in TheDanniCraft/activity-log
4. 🚀 Created a new tag v1.0.1 in TheDanniCraft/activity-log
5. 📝 Committed to TheDanniCraft/activity-log
6. 📝 Committed to TheDanniCraft/activity-log
7. 🚀 Created a new tag v1.0.0 in TheDanniCraft/activity-log
8. 📝 Committed to TheDanniCraft/activity-log
9. 📝 Committed to TheDanniCraft/activity-log
10. 📝 Committed to TheDanniCraft/activity-log

📖Usage

• Create the section in your README.MD by adding a start <!--START_SECTION:activity--> and end <!--END_SECTION:activity-->. You can find an example here.

• Create a Personal Acces Token with repo scopes and add the token as Repository Secret.

• Now create the workflow file.

# .github/workflows/update-activity.yml:

name: Update GitHub Activity

on:
  schedule:
    - cron: "*/30 * * * *" # Runs every 30 minutes
  workflow_dispatch: # Allows manual triggering

jobs:
  update-activity:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Update GitHub Activity
        uses: TheDanniCraft/activity-log@v1
        with:
          GITHUB_USERNAME: "thedannicraft"
          GITHUB_TOKEN: ${{ secrets.TOKEN }}

Take a look at all possible Inputs for customization

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:

• CreateEvent
• PushEvent
• IssuesEvent
  • opened
  • edited
  • closed
• PullRequestEvent
  • opened
  • synchronize
  • closed
  • merged
• ReleaseEvent
• ForkEvent
• CommitCommentEvent
• IssueCommentEvent
• PullRequestReviewEvent
• PullRequestReviewCommentEvent
• RepositoryEvent
• WatchEvent
• StarEvent
• PublicEvent

You can find an example here.

Inputs

Input	Description	Required	Default
GITHUB_USERNAME	The GitHub username.	Yes	-
GITHUB_TOKEN	The GitHub token.	Yes	-
EVENT_LIMIT	The maximum number of events to display.	No	10
IGNORE_EVENTS	The events to ignore, specified as a JSON array.	No	[]
README_PATH	The path to the README file.	No	README.MD
COMMIT_MESSAGE	Commit Message	No	Update README.md with latest activity

📜License

MIT

✍️Authors

• @thedannicraft