Skip to content

Releases: bmiit145/auto-streak-keeper

v1.0.2

04 Jan 06:43
Compare
Choose a tag to compare

What's Changed

  • Add branch name input to auto-streak-keeper by @bmiit145 in #7
  • Fix branch handling in auto-streak-keeper by @bmiit145 in #9

Full Changelog: v1.0.1...v1.0.2

What's Changed

  • Add branch name input to auto-streak-keeper by @bmiit145 in #7
  • Fix branch handling in auto-streak-keeper by @bmiit145 in #9
  • Add random delay between commits to prevent bot detection by @bmiit145 in #11

Full Changelog: v1.0.1...v1.0.2

v1.0.1

04 Jan 04:22
Compare
Choose a tag to compare

What's New

Auto-Streak Keeper is a GitHub Action designed to help maintain your GitHub streak by automating file creation, updates, and commits on a daily schedule. This initial release includes:

  • Daily Updates: Automatically create or update a file (data.txt) with new content.
  • Customizable Inputs:
    • file-path: Specify the file to update (default: public/auto-streak/data.txt).
    • min-commits and max-commits: Set a range for the number of daily commits.
    • commit-message: Customize the commit message.
  • Automatic Branch Management:
    • Creates and pushes updates to a dedicated branch (auto-streak-keeper).
    • Validates and pulls the branch if it already exists remotely.
  • GitHub Streak Maintenance: Ensures daily activity to maintain your streak with minimal effort.

How to Use

  1. Add the action to your workflow:
     name: Maintain GitHub Streak
    
     on:
     schedule:
       - cron: "0 0 * * *" # Runs daily at midnight
     workflow_dispatch:
    
     jobs:
     auto-streak:
       runs-on: ubuntu-latest
       permissions:
         contents: write
    
       steps:
         - name: Checkout Repository
           uses: actions/checkout@v3
    
         - name: Set up Node.js
           uses: actions/setup-node@v3
           with:
             node-version: "20"
    
         - name: Run Auto-Streak Keeper
           uses: bmiit145/[email protected]
           with:
             file-path: "public/auto-streak/data.txt"
             min-commits: 2
             max-commits: 5
             commit-message: "Daily streak maintenance"
             user-name: ${{ secrets.GITHUB_USER_NAME }}
             user-email: ${{ secrets.GITHUB_USER_EMAIL }}
             github-token: ${{ secrets.GITHUB_TOKEN }}
    
  2. Push the workflow and let the action take care of maintaining your GitHub streak!

Highlights

  • Fully automated workflow for consistent GitHub activity.
  • Simple and user-friendly customization options.
  • Optimized for streak maintenance enthusiasts.