chiubaca / shiba-every-hour

GitHub Action to post a Shiba to Twitter every hour. Because why not? 🐕

Shiba Every Hour

A GitHub Action which posts a picture of a Shiba to Twitter every hour.

wow

Ok, seriously why?

I like Shiba's ok?

But Seriously...

There probably is a legit use case somewhere here... You just need to look harder.

• Perhaps you want to tweet your application service status every hour via a health check API?
• You could post a tweet every time is a PR is merged into your master branch?
• You could post cat images every hour instead!?

The sky's the limit!

Developing Locally

1. Clone this repo to your machine.

2. Create a .env in the root directory.

3. Inside the .env you will need to create four variables. CONSUMER_KEY , CONSUMER_SECRET, ACCESS_TOKEN_KEY and ACCESS_TOKEN_SECRET. These need to be populated with your own Twitter API keys which you can get by signing up at https://developer.twitter.com/ .

4. Your .env file should look something like this.

CONSUMER_KEY = hvdVM7ZGshibasaresogreat3ZvE5tXh0E4h
CONSUMER_SECRET = 4ez9dEyAeGtbnXeca-ha-ha-M0i5wI02e1vPa
ACCESS_TOKEN_KEY = 8185583706135142-not-a-real-key-gPwxau3Yi0adA
ACCESS_TOKEN_SECRET = wow-fsaa2muchwoof

5. You can then run npm run dev-shibe to run the script locally.

Modifying the Action or Script

Feel free to adapt this script for your own purposes.

The hourly schedule is configured in ./.github/workflows/post-shibe.yml.

All the logic to fetch a Shiba image and post to Twitter is in ./index.js.

Publishing to Github

⚠ Do NOT publish your .env to GitHub. Doing this will let anyone send posts to your Twitter account on your behalf.

1. Add your Twitter API as GitHub secrets like so:

Happy hacking 🤓.