Skip to content

Commit

Permalink
welcome to the shell land.
Browse files Browse the repository at this point in the history
  • Loading branch information
naisanzaa committed Jan 26, 2024
1 parent 2ad683f commit 5469b9f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 35 deletions.
16 changes: 6 additions & 10 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
on:
workflow_dispatch: {}
schedule:
# Makes commit(s) at 9am daily
# Change to whatever cron expression you like
- cron: "0 9 * * *"
# At 00:00 on day-of-month 1.
- cron: "0 0 1 * *"

jobs:
lit-job:
actions_keepalive:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
runs-on: ubuntu-latest
name: A job to get you lit

name: Github Actions KeepAlive
steps:
- uses: actions/checkout@v3
- name: make commits
# Uses GitHub action defined in https://github.com/FredaXin/gitlit
uses: FredaXin/gitlit@main
uses: TheShellLand/github-actions-keepalive@latest
with:
# Defines the range of number of commits
# Change to your desierd lower and upper bound
lower-bound: 0
upper-bound: 6
# Change to your GitHub username
user-name: YourGithubUserName
# Change to your email used for GitHub account
Expand Down
32 changes: 7 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,11 @@
# It's Lit! :evergreen_tree:
# Github Actions KeepAlive Template

## What is it?
*It's Lit* is a GitHub template which you can use to create automated git commits daily, so your GitHub Contribution Graph will be green as a summer field throughout the year.
## What?

Creates an empty commit every month, to keep Github Actions alive from being
disabled.

## How does it work?
*It's Lit* utilizes a GitHub action, defined in the [*gitlit*](https://github.com/FredaXin/gitlit) repo. The action can be set on a cron schedule, or triggered manually. The GitHub action will make a randomized number of empty git commits.
## How?


## How to use it?
1. Create a repository from the *It's Lit* template:
- Click the green "Use this template" button in the upper right.
- Select "Create a new repository"

2. In your new repo, edit the [`.github/workflows/main.yml`](./.github/workflows/main.yml) file and add in your GitHub username and email.
(Optional) Edit the cron expression to your desired schedule.
(Optional) Edit the upper bond and lower bond of the total number of commit per action.

3. Ensure the Workflow has the correct permissions:
In GitHub UI, navigate to your newly created repo, go to `settings -> Actions -> Workflow permissions`, choose `Read and write permissons` and then `save`.


## Cool template, but why?
"Why do I need this template", you might ask? GitHub has become a hybrid repo host and social network that incentivizes user engagement by [gamification](https://shesho.medium.com/why-gamification-is-broken-and-how-to-fix-it-f12987840eb7). It might appear very productive to make frequent commits to keep your GitHub Contribution graph green, it might even give you some dopamine boosts during your daily GitHub routine, but can it translate into meaningful work and deep engagement?

Think of *It's Lit* as an automatic lawn sprinkler system: it keeps your graph green and maintains the curb appeal of your GitHub profile; it frees you from busy work so you can do the work that matters.

Let the roots of your thoughts grow deeper, the trunks of your projects grow taller. We can all use more trees than lawns. :evergreen_tree: :evergreen_tree: :evergreen_tree:
Run this custom docker
action: [Github Actions KeepAlive](https://github.com/TheShellLand/github-actions-keepalive)

0 comments on commit 5469b9f

Please sign in to comment.