https://github.com/offensive-vk/auto-user-activity

Fetch Recent Activity of a Github User.
https://github.com/offensive-vk/auto-user-activity

Last synced: 19 days ago
JSON representation

Fetch Recent Activity of a Github User.

• Host: GitHub
• URL: https://github.com/offensive-vk/auto-user-activity
• Owner: offensive-vk
• License: mit
• Created: 2024-11-30T17:50:47.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-12-08T13:44:31.000Z (26 days ago)
• Last Synced: 2024-12-13T01:33:36.034Z (21 days ago)
• Language: JavaScript
• Size: 1.29 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Auto User Activity

This GitHub Action automatically fetches and updates the recent activity of a GitHub user in the specified markdown file (e.g., `README.md`).

## Features

- Fetches up to a specified number of recent activities from the user's GitHub profile.

- Updates the designated markdown file between the specified comment tags.

- Supports empty commits to keep the workflow active after prolonged inactivity.

- Provides detailed debugging options for verbose logging.

---

## Recent Activity

1. No recent activity to show.

---

## Inputs

The action supports the following input parameters:

| Name            | Description                                            | Default                           |

|-----------------|-------------------------------------------------------|-----------------------------------|

| `token`         | Your GitHub PAT or Auth Token                         | `${{ secrets.GITHUB_TOKEN }}`    |

| `username`      | The GitHub username to fetch activity for             | `${{ github.repository_owner }}` |

| `committer`     | The name of the committer                             | `github-actions[bot]`            |

| `committer-email` | The email of the committer                          | `github-actions[bot]@users.noreply.github.com` |

| `commit-msg`    | Commit message for changes                           | `:zap: Update README with recent activity` |

| `max-lines`     | The maximum number of activity entries to show       | `5`                               |

| `target-file`   | The markdown file to update                          | `README.md`                       |

| `empty-commit-msg` | Message for empty commits (no activity)            | `:memo: empty commit to keep workflow active` |

| `debug`         | Enable verbose logging (set `true` or `false`)        | `false`                           |

## Example Workflow

Here is an example of how to configure the action in your repository:

```yaml

name: Update GitHub Activity

on:

  schedule:

    - cron: "0 * * * *" # Runs hourly

  workflow_dispatch: # Allows manual trigger

jobs:

  update-activity:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout Repository

        uses: actions/checkout@v3

      - name: Run Auto User Activity

        uses: offensive-vk/auto-user-activity@v1

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

          username: ${{ github.repository_owner }}

          commit-msg: ":zap: Updated activity in README"

          debug: true

```