How do I install and configure activity-box?

Follow the setup steps in the README: create a public Gist, generate a token with Gist scope, use the template repository, and set up the workflow file with environment variables like GH_PAT and GIST_ID. It involves cloning the template and adding secrets to your GitHub repository settings.

activity-box or GitHub profile README—which is better for showing activity?

activity-box is better for automated, scheduled updates of recent activity in a pinned gist, while a profile README offers more customization but requires manual updates. Choose based on whether you prioritize automation or design flexibility.

Can I customize the output format of activity-box?

No, activity-box uses a fixed format for displaying activity, such as commits and issues, without built-in customization options. The output is limited to the default Gist rendering, which is plain text or markdown.

Does activity-box work with private repositories?

The README doesn't specify, but since it uses the GitHub API with a token, it might access private data if the token has appropriate scopes. However, the gist is public, so displaying private activity could pose privacy concerns.

How often can I set the update schedule?

You can configure the cron job in the workflow file to run as frequently as desired, such as every 10 minutes, but be mindful of GitHub Actions' rate limits and execution time constraints to avoid failures.

What happens if my GH_PAT token expires?

If the token expires or is invalid, the workflow will fail to update the gist. You'll need to generate a new token and update the secret in your repository settings to restore functionality, which adds maintenance overhead.

Open-Awesome

activity-box

ISCJavaScript

A GitHub Action that updates a pinned gist with your latest GitHub activity.

GitHub

224 stars60 forks0 contributors

What is activity-box?

activity-box is a GitHub Action that updates a pinned GitHub Gist with a user's latest activity, such as commits, issues, and pull requests. It automates the process of keeping a public gist current with recent GitHub contributions, providing a dynamic way to showcase activity on a user's profile.

Target Audience

GitHub users who want to automatically display their recent activity in a pinned gist on their profile, particularly developers looking to enhance their profile visibility with minimal manual effort.

Value Proposition

Developers choose activity-box because it simplifies the process of maintaining an up-to-date activity display using GitHub's native Actions and Gists, requiring only initial setup and then running automatically on a schedule.

Overview

⚡️📌 Update a pinned gist to contain the latest activity of a user

Use Cases

Best For

Automatically updating a pinned gist with GitHub activity
Showcasing recent commits, issues, and pull requests on a profile
Setting up a scheduled workflow for profile maintenance
Enhancing GitHub profile visibility with dynamic content
Using GitHub Actions for personal automation projects
Creating a public activity feed without manual updates

Not Ideal For

Users wanting richly styled or embeddable activity feeds beyond basic Gist formatting
Projects requiring real-time activity updates without scheduled intervals
Teams needing centralized management of multiple users' GitHub activity from a single dashboard
Organizations with strict security policies that prohibit personal access token usage for automation

Pros & Cons

Pros

Automated Scheduling

Leverages GitHub Actions' schedule event to run automatically on a cron job, ensuring the gist stays updated without manual intervention, as shown in the workflow example with cron configuration.

Template-Based Setup

Provides a ready-to-use template repository via the 'Use this template' button, streamlining initial configuration and reducing setup complexity for users.

Minimalist and Focused

Follows a minimalist philosophy, concentrating solely on updating activity data like commits and issues without bloat, making it lightweight and easy to maintain.

Seamless GitHub Integration

Uses native GitHub tools like Actions and Gists, ensuring compatibility and reducing dependencies on external services, as it's designed specifically for the GitHub ecosystem.

Cons

Token Management Overhead

Requires creating and securely storing a personal access token with Gist scope, adding complexity and potential security risks if tokens are mishandled, as highlighted in the setup steps.

Limited Output Customization

The activity is displayed in a plain Gist format with no built-in options for styling or advanced formatting, restricting aesthetic control and personalization.

Scheduled Updates Only

Updates are tied to a cron schedule, meaning activity data isn't reflected in real-time and may have delays, such as the example running every 10 minutes.

Frequently Asked Questions

Related Projects

productive-box

Are you an early 🐤 or a night 🦉? Let's check out in gist

Stars540

Forks7,522

Last commit1 year ago

github-stats-box

📌 Update a gist to contain your GitHub stats

Stars160

Forks1,574

Last commit2 years ago

lang-box

💻 Update a pinned gist to contain languages of your recent commits in GitHub

Stars58

Forks160

Last commit6 months ago

github-activity-box

⚡️📌 Update a pinned gist to show your latest GitHub activity (issues and PRs).

Stars5

Forks1