Repository navigation
[Docs]: Prepare repository for open source release - #1
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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.tfhardcoded the GCP project ID. Nowvar.gcp_project, declared invariables.tfand present interraform.tfvars.example.manifests/ingress.yamlcarried Tailscale annotations tying it to a private tailnet. Removed.Deployers:
terraform.tfvarsnow needs agcp_projectvalue or apply will fail.Pre-publication audit
Scanned before opening this up:
.envever committedmanifests/secret.yamlREPLACE_ME.env.example,terraform.tfvars.examplearchae0pteryx <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.