Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.94 KB

README.md

File metadata and controls

46 lines (32 loc) · 2.94 KB
Raw

Make your contributor graph say Abolish ICE

Contributor Graph

Usage

  1. have the git command installed, and (optionally) wget or curl
  2. get this repo, git clone [email protected]:rossabaker/abolish-ice-graphiti.git
  3. update dates.txt for current week, via ./dates.sh < dow.txt > dates.txt or ./raster.sh (use ./raster -h to see all the options)
  4. On Github, create a new target repo to be graffitied. I like abolish-ice
  5. get a local copy of the target repository with git clone
  6. make a new branch, perhaps git checkout -b drop-ice
  7. run username=<user> ./<path_to_repo>/abolish-ice-graphiti/paint.sh in the target repo, with your git user name so we get the commit count right,
    • or ./<path_to_repo>/abolish-ice-graphiti/paint.sh if you don't have have curl/wget
    • or commitmax=<most_commits_in_one_day> ./<path_to_repo>/abolish-ice-graphiti/paint.sh if you don't have curl/wget and your colors are wrong cuz you have a pre-existing day with more than 50 commits (see Troubleshooting below)
  8. [optionally] switch default branch back and forth if things look wrong (see Troubleshooting below)

refreshing

  1. Visit the GitHub settings page for yor target repo (abolish-ice) and under the branches tab, switch the default github branch back to the one without graffiti commits
  2. reset graffiti branch from placeholder branch, git reset main
  3. update dates.txt for current week (2. reprised)
  4. run paint.sh, with the users name (6. reprised)
  5. paint.sh's git push will fail, so do a git push -f [maybe the git push doesn't really belong in paint.sh but in a parent script?]
  6. switch the default github branch back to the one with graffiti commits

Troubleshooting

It didn't show up

See the guide on which contributions count. Specifically, make sure:

  • The repository you run paint.sh in is not a fork.
  • You run it on the default branch of your repository.

It's hard to read

The script needs to generate many more commits than your busiest days to make a loud and clear statement. You can use the environmental variable username to tell paint.sh your github user (username=myname ./paint.sh) and it can check your profile, provided you have curl or wget installed. Otherwise, The maxcommit variable directly determines the number of commits. If your graph does not turn a crisp, dark green "ABOLISH ICE,"" try maxcommit=100 ./paint.sh or higher.

Fading

If the right side of the graph is dark green but the rest is faded, then you can try switching the default branch of your abolish-ice repository back to main (or some non-graffitied branch), and then switching back to the branch with your graffiti commits. This issue is being tracked under #10.

Credit

Bootstrapped from github-graffiti.