Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pikesley/pokrovsky
Github-History-Vandalism-as-a-Service
https://github.com/pikesley/pokrovsky
Last synced: 8 days ago
JSON representation
Github-History-Vandalism-as-a-Service
- Host: GitHub
- URL: https://github.com/pikesley/pokrovsky
- Owner: pikesley
- License: mit
- Created: 2013-11-30T15:01:23.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-23T22:46:37.000Z (almost 2 years ago)
- Last Synced: 2024-08-05T09:13:15.719Z (3 months ago)
- Language: CSS
- Homepage: http://pokrovsky.herokuapp.com/
- Size: 1.27 MB
- Stars: 46
- Watchers: 5
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pokrovsky
_Github History Vandalism as a Service_
The unbroken chain of pointless Things-as-a-Service continues. This one uses my [Uncle Clive](//github.com/pikesley/uncle-clive) tool (via my [Dead Cockroach](//github.com/pikesley/dead-cockroach) tool) to generate a script suitable for vandalising your Git commit history ([my account](//github.com/pikesley) is probably displaying an example right now).
### API
#### `/:user/:repo/:text`
Will return a bash script which, when run locally, will:
* initialise a local git repo named `:repo`
* create a series of empty commits
* push the repo to `[email protected]:user/repo.git`
The commits will be structured such that they will 'write' the **first six characters** of _:text_ on the Github commit calendar using the 1982 Sinclair Spectrum character set. There is a limitation in that the Spectrum font is 8 units high, and the Github calendar has a height of 7 (see [dead-cockroach](//github.com/pikesley/dead-cockroach/blob/master/README.md) for an explanation of how this is handled).
All of the above assumes that you can do public-key authentication to Github from the box on which you're running this.
## Running it
This *used* to all run on the Heroku free-tier, but they stopped that party in November 2022, so I've now revived it with an over-elaborate `docker-compose` setup. You need to check out three different repos, so find somewhere on your laptop where you wanna put it all, then:
```
for REPO in uncle-clive dead-cockroach pokrovsky ;
do
git clone https://github.com/pikesley/${REPO}
done
```
Then create the `docker-compose` files:
```
cat < docker-compose.yaml
version: "3.9"
services:
uncle-clive:
build: uncle-clive
image: pikesley/uncle-clive
ports:
- ${CLIVE_PORT}:${CLIVE_PORT}
working_dir: /opt/uncle-clive
command: bundle exec rackup -p ${CLIVE_PORT} -o 0.0.0.0
dead-cockroach:
build: dead-cockroach
image: pikesley/dead-cockroach
ports:
- ${COCKROACH_PORT}:${COCKROACH_PORT}
working_dir: /opt/dead-cockroach
environment:
CLIVE_PORT: ${CLIVE_PORT}
command: bundle exec rackup -p ${COCKROACH_PORT} -o 0.0.0.0
pokrovsky:
build: pokrovsky
image: pikesley/pokrovsky
ports:
- ${POKROVSKY_PORT}:${POKROVSKY_PORT}
working_dir: /opt/pokrovsky
environment:
POKROVSKY_PORT: ${POKROVSKY_PORT}
COCKROACH_PORT: ${COCKROACH_PORT}
command: bundle exec ruby lib/pokrovsky.rb
EOF
cat < .env
CLIVE_PORT=6060
COCKROACH_PORT=7070
POKROVSKY_PORT=8080
EOF
```
And build and run it:
```
docker compose build
docker compose up
```
### Using it
To actually vandalise your GH commit graph, from a different terminal,
```
export SERVER=http://localhost:8080
export REPO=dummy
export TEXT=`echo "© 1982" | sed "s: :%20:g"`
export GHUSER=yourghuser
curl "${SERVER}/${GHUSER}/${REPO}/${TEXT}" | bash
```
(Note: there's some latency before the commits actually appear in your graph, be patient)
### Notes
* This is *ancient* Ruby and I have no interest in updating it. Many of the tests are now busted and I really don't care.
* You should start with a fresh repo each time, both locally and on Github. The script makes no attempt to create a new Github repo, and it certainly doesn't try to delete anything from there. If you can't work out how to do this safely, you probably shouldn't use these tools.
* If you decide this isn't for you after all, just delete the repo and it will all go away.
* This owes a _massive_ debt to [Gelstudios'](//github.com/gelstudios) splendid [Gitfiti](//github.com/gelstudios/gitfiti).
* I gave a talk about this at [EMF Camp 2014](//sam.pikesley.org/talks/#vandalising-your-github-commit-history-emf-2014).