streak-maintain is a GitHub repository designed to help developers effortlessly maintain their GitHub streaks by leveraging the powerful Auto-Streak Keeper GitHub Action. This repository is pre-configured with a workflow that automatically creates and updates a file daily, ensuring consistent activity to keep your streak alive.
- Automated Streak Management: The repository uses the Auto-Streak Keeper action to automate daily commits and maintain your GitHub activity streak.
- No Configuration Required: Get started immediately with the pre-configured workflow.
- Customizable Workflow: Easily modify parameters like the file path, commit message, and number of daily updates.
- Reliable and Consistent: Ensures activity is logged daily, helping you maintain your streak even during busy days.
- The Auto-Streak Keeper action is triggered daily via a scheduled workflow.
- A file (
data.txt
) is created or updated with new content in the repository. - The changes are committed and pushed to a dedicated branch, ensuring activity is logged for the day.
- Clone this repository to your account.
- Enable the workflow by navigating to the Actions tab and activating workflows.
- Customize the workflow file (
.github/workflows/streak-maintain.yml
) to suit your needs.
Example Workflow:
name: Maintain GitHub Streak
on:
schedule:
- cron: "0 0 * * *" # Runs daily at midnight
workflow_dispatch:
jobs:
streak-maintain:
runs-on: ubuntu-latest
steps:
- name: Auto-Streak Keeper
uses: bmiit145/auto-streak-keeper@v1.0.0
with:
file-path: "public/auto-streak/data.txt"
min-commits: 2
max-commits: 5
commit-message: "Automated daily update to maintain streak"
user-name: ${{ secrets.GITHUB_USER_NAME }}
user-email: ${{ secrets.GITHUB_USER_EMAIL }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- Stay Consistent: Never miss a day of activity, even during breaks or busy schedules.
- Fully Automated: Let the repository handle the streak maintenance for you.
- Easy Integration: Works out of the box with minimal setup.
Fork or clone the repository and let it handle the rest! 🎉
Keep your GitHub streak alive effortlessly with streak-maintain.
Let me know if you'd like further refinements to the description!