Skip to content

streak-maintain helps you effortlessly keep your GitHub streak alive using the Auto-Streak Keeper action. It automates daily updates to a file, commits changes, and pushes them to a branch. Pre-configured and customizable, this repository ensures consistent activity, making streak maintenance simple and reliable for all developers.

Notifications You must be signed in to change notification settings

SpiritITSolutions/streak-maintain

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 

Repository files navigation

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.


Features

  • 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.

How It Works

  1. The Auto-Streak Keeper action is triggered daily via a scheduled workflow.
  2. A file (data.txt) is created or updated with new content in the repository.
  3. The changes are committed and pushed to a dedicated branch, ensuring activity is logged for the day.

Usage

  1. Clone this repository to your account.
  2. Enable the workflow by navigating to the Actions tab and activating workflows.
  3. 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 }}

Why Use streak-maintain?

  • 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.

Get Started

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!

About

streak-maintain helps you effortlessly keep your GitHub streak alive using the Auto-Streak Keeper action. It automates daily updates to a file, commits changes, and pushes them to a branch. Pre-configured and customizable, this repository ensures consistent activity, making streak maintenance simple and reliable for all developers.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published