sxsphinxstack

Projects / A GitHub Action that does a real job in your repo

A GitHub Action that does a real job in your repo

Level 2: two to three weeks, real architecture. Use with: automate-a-task, ship-on-github. Resume line when done: Built CI automation for {repo_name} — a GitHub Action that {job}, running on every push for {n} weeks

Brief

Pick something you do by hand in one of your existing repos every time you touch it: checking that the links in the README still work, regenerating a stats table from a data file, compressing images before commit, validating that a JSON file still parses. Build a GitHub Action that does it for you, on push or on a schedule. Actions minutes are free on public repos, so the whole project costs nothing. The point is a robot teammate for a repo you already care about, so the automation gets exercised by your real commits.

Personalize

Milestones

  1. Do the chore by hand one more time and write down every step and how long it took. That is the baseline.
  2. Script the chore so one local command does the whole thing. Run it against the repo's history to make sure it behaves on real past states, ugly ones included.
  3. Wrap the script in a workflow file triggered manually (workflow_dispatch). Run it from the Actions tab and read the logs.
  4. Switch the trigger to the real event: push, pull request, or cron, whichever matches the chore.
  5. Make failure useful: when the Action fails, the log says exactly what is wrong and where, in your words.
  6. If the Action writes changes back, scope its permissions to the minimum and make the bot commit clearly labeled as automated.
  7. Break the repo on purpose (a dead link, an invalid JSON edit) and confirm the Action catches it.
  8. Let it ride your normal commits for two weeks without manual runs.
  9. README badge plus a short section: what the Action does and what the repo looked like before it existed.

Done means