Skip to content

[Docs]: Prepare repository for open source release - #1

Merged
archae0pteryx merged 4 commits into
mainfrom
docs/open-source-prep
Jul 30, 2026
Merged

archae0pteryx merged 4 commits into
mainfrom
docs/open-source-prep

Conversation

@archae0pteryx

Copy link
Copy Markdown
Contributor

Gets the repo ready to be made public.

README

Rewritten around the actual pitch: one GraphQL API over the free and open catalogues of music, podcasts, and audiobooks. The old version listed features without saying why the project exists — the fragmentation across MusicBrainz, Audius, Jamendo, PodcastIndex, and LibriVox is the reason, so it leads with that now.

Added:

  • A source table making the credential story explicit — three of five need no auth at all, the other two are free registrations. That's the main question anyone evaluating this will have.
  • A contributing bar: a new source must be free to query and openly licensed. Keeps the project from drifting into a paid-API wrapper.
  • A note that caching is a courtesy to volunteer-run archives, not just a latency win.
  • The PocketCereal logo.

License

MIT, copyright pocketcereal. An unlicensed public repo is all-rights-reserved by default, so nobody could legally use this without it.

Portability

Two things were specific to one environment and would have confused anyone else deploying:

  • terraform/main.tf hardcoded the GCP project ID. Now var.gcp_project, declared in variables.tf and present in terraform.tfvars.example.
  • manifests/ingress.yaml carried Tailscale annotations tying it to a private tailnet. Removed.

Deployers: terraform.tfvars now needs a gcp_project value or apply will fail.

Pre-publication audit

Scanned before opening this up:

Check Result
.env ever committed Never — gitignored from the first commit
Secrets in full history (50 commits) None
manifests/secret.yaml All REPLACE_ME
.env.example, terraform.tfvars.example Placeholders only
Personal name / email / phone / local paths None
Commit author identity archae0pteryx <github@pocketcereal.com>

The long UUIDs in test fixtures are MusicBrainz identifiers — public data.

Not touched: .serena/project.yml (unrelated local change) and the untracked .claude/ directory.

Rewrite README around what Spoons actually is: one GraphQL schema over
five free and open media catalogues. Add a source table making the
credential story explicit — three of five need no auth, the other two
are free registrations — plus a contributing bar that new sources must
be free to query and openly licensed.

Add MIT LICENSE and the PocketCereal logo.

Remove deployment details specific to one environment so the manifests
are usable by anyone:
- terraform: replace the hardcoded GCP project with var.gcp_project,
  declared in variables.tf and added to terraform.tfvars.example
- manifests: drop Tailscale ingress annotations

Note for deployers: terraform.tfvars now needs a gcp_project value.
.serena/ was tracked from before the ignore rule existed; .claude/ was
untracked. Neither belongs in a public repo — both are local editor and
agent state, not project source.

Remove .serena/ from the index and add .claude/ to .gitignore.
Agent instruction files are local working config, not project source.
Remove them from the index and ignore them; both stay on disk.

Also drops the "!CLAUDE.md" negation that existed to force-track it
past a global gitignore.
clippy::useless_borrows_in_formatting fires on `&self.hosts[index]`
inside format!. Pre-existing on main; a newer clippy started flagging
it and CI runs with -D warnings.
@archae0pteryx
archae0pteryx merged commit 25de109 into main Jul 30, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant