Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/thedannicraft/activity-log
activity bun github-action-javascript github-actions github-workflow hacktoberfest javascript profile-page profile-readme readme readme-profile
Last synced: 2 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/thedannicraft/activity-log
- Owner: TheDanniCraft
- License: mit
- Created: 2024-07-25T15:30:27.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-12-25T16:35:24.000Z (5 days ago)
- Last Synced: 2024-12-25T17:25:40.967Z (5 days ago)
- Topics: activity, bun, github-action-javascript, github-actions, github-workflow, hacktoberfest, javascript, profile-page, profile-readme, readme, readme-profile
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/readme-activity-update
- Size: 383 KB
- Stars: 2
- Watchers: 2
- Forks: 53
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
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. 🔀 Merged a PR in a private repo
2. 🔀 Merged a PR in a private repo
3. 🗣 Commented on an issue in a private repo
4. 🔀 Merged [PR #44](https://github.com/Wiresense/frontend/pull/44) in [Wiresense/frontend](https://github.com/Wiresense/frontend)
5. 🔎 Reviewed [PR #44](https://github.com/Wiresense/frontend/pull/44) in [Wiresense/frontend](https://github.com/Wiresense/frontend)
6. 🔀 Merged [PR #74](https://github.com/TheDanniCraft/Portfolio/pull/74) in [TheDanniCraft/Portfolio](https://github.com/TheDanniCraft/Portfolio)
7. 🔀 Merged [PR #75](https://github.com/TheDanniCraft/Portfolio/pull/75) in [TheDanniCraft/Portfolio](https://github.com/TheDanniCraft/Portfolio)
8. 🔀 Merged a PR in a private repo
9. 🔀 Merged [PR #72](https://github.com/TheDanniCraft/Portfolio/pull/72) in [TheDanniCraft/Portfolio](https://github.com/TheDanniCraft/Portfolio)
10. 🔀 Merged [PR #42](https://github.com/Wiresense/frontend/pull/42) in [Wiresense/frontend](https://github.com/Wiresense/frontend)
## 📖Usage
### 1. Add Sections to `README.md`
Include the following placeholders in your `README.md` where you want the activity log to appear:
```markdown
```
For a reference example, you can view this [sample `README.md`](https://github.com/TheDanniCraft/activity-log/blob/master/README.md?plain=1#L20-L31).
### 2. Create a Personal Access Token
Quick Setup (Recommended)
1. To create a personal access token with the necessary permissions, click this [link to create a new token](https://github.com/settings/tokens/new?description=Github%20Activity%20Log%20(TheDanniCraft/activity-log)&scopes=repo). This link pre-fills the token description and scopes for your convenience.
2. On the token creation page, review the pre-filled data and set the expiration date to "Never".
3. Click "Generate token" and copy the token (be sure to save it as you won’t be able to see it again).
Manual Setup
1. Go to your GitHub [Personal Access Tokens settings](https://github.com/settings/tokens).
2. Click on "Generate new token".
3. Provide a descriptive name for the token, such as `Github Activity Log (TheDanniCraft/activity-log)`.
4. Select the `repo` scope (recommended if you want private repo activity to show up).
5. Set the expiration date to "Never".
6. Click "Generate token" and copy the token (be sure to save it as you won’t be able to see it again).
### 3. Add the Token as a Repository Secret
1. Navigate to your GitHub repository.
2. Go to "Settings" > "Secrets and variables" > "Actions".
3. Click "New repository secret".
4. Name the secret (e.g., `TOKEN`).
5. Paste the personal access token into the value field.
6. Click "Add secret".
### 4. Create the Workflow File
Create a new file in your repository under `.github/workflows/`, for example, `activity-log.yml`. Add the following content to this file:
```yml
# .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 }} # Ensure this matches the secret name in repository settings
```
Take a look at all possible [Inputs](#inputs) for customization
The above job runs every half an hour, you can change it as you wish based on the [cron syntax](https://crontab.guru).
Please note that only those public events that belong to the following list show up:
- `CreateEvent`
- `PushEvent`
- `IssuesEvent`
- `opened`
- `edited`
- `closed`
- `reopened`
- `assigned`
- `unassigned`
- `labeled`
- `unlabeled`
- `PullRequestEvent`
- `opened`
- `edited`
- `closed`
- `merged`
- `reopened`
- `assigned`
- `unassigned`
- `review_requested`
- `review_request_removed`
- `labeled`
- `unlabeled`
- `synchronize`
- `ReleaseEvent`
- `ForkEvent`
- `CommitCommentEvent`
- `IssueCommentEvent`
- `PullRequestReviewEvent`
- `PullRequestReviewCommentEvent`
- `RepositoryEvent`
- `WatchEvent`
- `StarEvent`
- `PublicEvent`
- `GollumEvent`
You can find an example [here](https://github.com/TheDanniCraft/activity-log/blob/master/.github/workflows/update-activity.yml).
### Inputs
| **Input** | **Description** | **Required** | **Default** | **Possible Options** |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------|-----------------------------------------------------------------------------|
| `GITHUB_USERNAME` | Your GitHub username. | ✅ | `-` | A valid GitHub username |
| `GITHUB_TOKEN` | Your GitHub token. | ✅ | `-` | A valid GitHub access token (must belong to the specified GitHub username) |
| `EVENT_LIMIT` | The maximum number of events to display. | ❌ | `10` | Any positive integer |
| `OUTPUT_STYLE` | Specifies the format in which your output should be rendered.
Must be one of:
- `MARKDOWN`: Output in Markdown format
- `HTML`: Output in HTML format | ❌ | `MARKDOWN` | `MARKDOWN` or `HTML` |
| `IGNORE_EVENTS` | The events to ignore, specified as a JSON array. | ❌ | `[]` | JSON array of event types (e.g., `["PushEvent", "PullRequestEvent"]`) |
| `README_PATH` | The path to your README file. | ❌ | `README.md` | Any valid file path |
| `COMMIT_MESSAGE` | Your commit message. | ❌ | `-` | Any valid commit message |
## 📜License
[MIT](https://choosealicense.com/licenses/mit/)
## ✍️Authors
- [@thedannicraft](https://www.github.com/thedannicraft)