\n GitHubSync\n
Sync vals from Val Town to GitHub and back
\n

\n View source\n \n ,\n );\n}",[],[151,177],{"_106":184,"_99":185,"_152":186,"_154":153,"_155":138,"_156":137,"_157":120,"_108":187,"_103":33,"_159":171,"_161":188,"_162":27,"_163":-5,"_164":189,"_102":190},"38f69924-ff86-11ef-ad47-569c3dd06744","middleware","c7bfde6b-246e-4064-9a4e-9ba48c164f5f",["D",1741813741761],"import { Webhooks } from \"npm:@octokit/webhooks\";\nimport { Context, Hono, Next } from \"npm:hono\";\nimport signWebhook from \"../sign-webhook\";\n\n\nexport const verifyGitHubSignature = (secret: string) => {\n const webhooks = new Webhooks({ secret });\n \n return async (c: Context, next: Next) => {\n const signature = c.req.header(\"x-hub-signature-256\");\n if (!signature) {\n console.error(\"Missing GitHub secret\");\n c.status(401);\n return c.body(\"Unauthorized\");\n }\n\n // const body = await c.req.json();\n const text = await c.req.text();\n // const body = await JSON.parse(text);\n\n if (!(await webhooks.verify(text, signature))) {\n console.error(\"Invalid GitHub secret\");\n c.status(401);\n return c.body(\"Unauthorized\");\n }\n\n console.log(\"GitHub secret verified\");\n await next();\n };\n};\n\n// Middleware for signature verification\nexport const verifyValSignature = (secret: string) => {\n return async (c: Context, next: Next) => {\n console.log(\"verifyValSignature\");\n const signature = c.req.header(\"x-val-signature\");\n if (!signature) {\n console.error(\"Missing signature\");\n return c.text(\"Missing signature\", 401);\n }\n\n const text = await c.req.text();\n const expectedSignature = await signWebhook(text, secret);\n\n if (signature !== expectedSignature) {\n console.error(\"Invalid signature\");\n return c.text(\"Invalid signature\", 401);\n }\n\n console.log(\"webhook secret verified\");\n await next();\n };\n};",[],[151,185],{"_106":192,"_99":193,"_152":194,"_154":153,"_155":138,"_156":137,"_157":120,"_108":195,"_103":33,"_159":171,"_161":196,"_162":27,"_163":-5,"_164":197,"_102":198},"38f69c8a-ff86-11ef-ad47-569c3dd06744","styles","31775bf9-f505-4335-86d5-1d5dfabed8b2",["D",1741813741761],"export const body = {\n fontFamily: \"sans-serif\",\n margin: 0,\n padding: 32,\n lineHeight: 1.5,\n color: \"black\",\n backgroundColor: \"white\",\n};\n\nexport const title = {\n fontSize: 48,\n};\n\nexport const description = {\n fontSize: 16,\n fontWeight: \"normal\",\n};",[],[151,193],{"_106":200,"_99":201,"_152":202,"_154":153,"_155":138,"_156":137,"_157":120,"_108":203,"_103":33,"_159":171,"_161":204,"_162":27,"_163":-5,"_164":205,"_102":206},"38f6b5ee-ff86-11ef-ad47-569c3dd06744","valtown-deploy","c988e50f-88db-44f6-a6c2-7b36ac4c10d0",["D",1741813741761],"import { decodeBase64 } from \"jsr:@std/encoding/base64\";\nimport { ValTown } from \"npm:@valtown/sdk\";\nimport { Octokit } from \"npm:@octokit/rest\";\nimport config from \"../config.json\" with { type: \"json\" };\n\nimport type { Context, Next } from \"npm:hono\";\n\nconst GITHUB_TOKEN = Deno.env.get(\"GITHUB_TOKEN\");\nconst VALTOWN_TOKEN = Deno.env.get(\"VALTOWN_TOKEN\");\n\nconst valtown = new ValTown({\n bearerToken: VALTOWN_TOKEN,\n});\nconst octokit = new Octokit({ auth: GITHUB_TOKEN });\nconst td = new TextDecoder();\n\n////\n\nexport default async function valTownDeploy(c: Context) {\n console.log(\"deploy to valtown\");\n const body = await c.req.json();\n const { ref, repository, after, commits } = body;\n\n if (ref !== config.branch) {\n console.log(`Update not on ${config.branch} branch (${ref})`);\n return c.json({ ok: true });\n }\n\n try {\n const updates = await getContents(repository, after, commits);\n console.log(`${updates.length} updates`);\n const user = await valtown.me.profile.retrieve();\n if (!user.username) {\n throw new Error(\"User not found: check your VALTOWN_TOKEN\");\n }\n console.log(\"got val.town user:\", user.username);\n await updateVals(user, updates);\n } catch (e) {\n console.error(e);\n c.status(500);\n return c.body(\"Error updating vals\");\n }\n\n return c.json({ ok: true });\n}\n\nasync function getContents(repo: Repo, after: string, commits: Commit[]) {\n const filenames = config.vals.map((name: string) => name + \".tsx\");\n console.log(`${filenames.length} val files updated`);\n const modified = getModified(commits, filenames);\n console.log(`${modified.length} modifications in commit`);\n const contents = await Promise.all(modified.map(getFileContent(repo, after)));\n console.log(`${contents.length} file contents`);\n return contents;\n}\n\nfunction getModified(commits: Commit[], filenames: string[]) {\n return commits.reduce((a: string[], b: Commit) => {\n return [...a, ...b.modified];\n }, []).filter((file: string) => filenames.includes(file));\n}\n\nfunction getFileContent(repo: Repo, after: string) {\n return async (path: string): Promise<{\n name: string;\n code: string;\n }> => {\n const { data } = await octokit.repos.getContent({\n owner: repo.owner.name,\n repo: repo.name,\n path,\n ref: after,\n });\n const [name] = path.split(\".\");\n const code = td.decode(decodeBase64(data.content));\n return {\n name,\n code,\n };\n };\n}\n\nasync function updateVals(user: ValUser, updates: { name: string; code: string; }[]) {\n console.log(\"updateVals\");\n await Promise.all(updates.map(async (update) => {\n updateVal(user.username, update)\n }));\n}\n\nasync function updateVal(username: string, update: { name: string; code: string; }) {\n const { name, code } = update;\n const val = await valtown.alias.username.valName.retrieve(username, name);\n console.log(\"updateVal\", { name, id: val.id });\n const ver = await valtown.vals.versions.create(val.id, { code });\n console.log(\"updated val:\", ver);\n}\n\n////\n\ntype Repo = {\n owner: {\n name: string;\n };\n name: string;\n};\ntype Commit = {\n modified: string[];\n};\ntype ValUser = {\n username: string;\n};",[],[151,201],[151],{"_106":209,"_99":210,"_152":211,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":212,"_103":33,"_159":213,"_161":214,"_162":27,"_163":-5,"_164":215,"_102":216},"38f6be0e-ff86-11ef-ad47-569c3dd06744","README.md","bef8df87-b050-4dbd-a797-6f62df97af28",["D",1741813741761],"file","# GitHubSync\n\nWebhook to commit vals to GitHub and sync code from GitHub back to Val Town\n\n## Demo\n\nThis [example val][] is synced to this [GitHub repo][]\n\n## How to set up\n\nThis val exposes two webhook endpoints:\n\n- `/push` will copy the contents from a list of vals specified in `config.json` and push them to a GitHub repo\n- `/deploy` is a GitHub webhook URL that will fetch contents from GitHub and update the code on Val Town\n\n1. Fork this val\n1. Edit `config.json` to point to the repo and vals you plan to sync\n1. Create a new repo on GitHub to sync to\n1. Add a webhook to your repo that points to this val's `/deploy` route, e.g. `https://username-.web.val.run/deploy`\n \n - Create a _secret_ for your webhook \n - In this val's _Environment Variables_, add that secret as `GITHUB_WEBHOOK_SECRET`\n1. On GitHub, create a new personal [access token][]\n - Ensure the token has read/write access to _Contents_ for the repo\n - Copy the access token and add that as the `GITHUB_TOKEN` env var in this val\n1. Add a new [Val Town API token][] with read/write permissions. Add that token to the val's env vars as `VALTOWN_TOKEN`\n1. Add a `VAL_SECRET` env var to the val. Use this secret to sign the webhook POST request to the `/push` endpoint. Use this endpoint to commit vals from Val Town to your GitHub repo.\n\n### Example push to GitHub fetch\n\nYou can use this example to POST to the `/push` endpoint to copy vals to GitHub.\nYou should keep the code for this private so that only you can push to GitHub.\nThis example can run manually or use a Cron val.\n\n**NOTE: this can overwrite changes made outside of Val Town, on GitHub/etc.**\n\n```tsx\n// This can post to the GitHubSync `/push` webhook; keep this private\nimport sign from \"https://esm.town/v/jxnblk/GitHubSync/sign-webhook\";\n\nconst secret = Deno.env.get(\"SECRET\") as string;\nconst url = Deno.env.get(\"PUSH_URL\") as string;\n\nasync function pushValsToGitHub() {\n const body = \"hello\";\n const signature = await sign(body, secret);\n\n const res = await fetch(url, {\n method: \"POST\",\n body,\n headers: {\n \"x-val-signature\": signature,\n }\n })\n \n if (!res.ok) {\n console.log(res);\n return;\n }\n const json = await res.json();\n console.log(json);\n}\n\npushValsToGitHub();\n```\n\n## Env vars\n\n- `GITHUB_TOKEN`: Read/write GitHub personal access token for reading and writing repo contents \n- `VALTOWN_TOKEN`: ValTown API token (with read/write Vals permissions) for writing updates from GitHub\n- `GITHUB_WEBHOOK_SECRET`: secret for verifying webhooks from GitHub\n- `VAL_SECRET`: secret for verifying requests to the `/push` endpoint\n\n---\n\nThis is the latest version of .\n_Note: This will currently only work with non-project vals until the SDK supports projects._\n\n\n\n\n[github oauth app]: https://github.com/settings/developers\n[access token]: https://github.com/settings/tokens\n[val town api token]: https://www.val.town/settings/api\n[troubleshooting]: #troubleshooting\n\n[github repo]: https://github.com/jxnblk/valtown-github-sync-v2\n[example val]: https://val.town/v/jxnblk/GitHubSyncV2DemoVal",[],[210],{"_106":218,"_99":219,"_152":220,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":221,"_103":33,"_159":171,"_161":222,"_162":27,"_163":-5,"_164":223,"_102":224},"38f6da6a-ff86-11ef-ad47-569c3dd06744","commit-files","38fffd00-c08b-48f0-8136-d2bf2e129f1a",["D",1741813741761],"import { Octokit } from \"npm:@octokit/rest\";\n\ninterface CommitOptions {\n token: string;\n owner: string;\n repo: string;\n files: {\n path: string;\n content: string;\n folder?: boolean;\n }[];\n branch?: string;\n message?: string;\n}\n\nconst FILE = \"100644\";\nconst FOLDER = \"040000\";\n\n/**\n * General use function to commit files to GitHub\n */\nexport async function commitFiles({\n token,\n owner,\n repo,\n files,\n branch = \"main\",\n message = \"published with https://val.town/x/jxnblk/GitHubSync\",\n}: CommitOptions) {\n const data: any = {};\n const gh = new Octokit({ auth: token });\n const user = await gh.rest.users.getAuthenticated();\n data.user = user.data;\n\n const ref = await gh.request(`GET /repos/${owner}/${repo}/git/ref/heads/${branch}`, {});\n data.ref = ref.data;\n\n // create tree\n const items = await Promise.all(\n files.map(async file => {\n const blob = await gh.request(`POST /repos/${owner}/${repo}/git/blobs`, {\n content: file.content,\n encoding: \"utf-8\",\n });\n\n return {\n path: file.path,\n sha: blob.data.sha,\n mode: file.folder ? FOLDER : FILE,\n type: \"blob\",\n };\n }),\n );\n\n const tree = await gh.request(`POST /repos/${owner}/${repo}/git/trees`, {\n base_tree: data.ref.object.sha,\n tree: items,\n });\n\n data.tree = tree.data;\n\n // create commit\n const commit = await gh.request(`POST /repos/${owner}/${repo}/git/commits`, {\n message,\n tree: data.tree.sha,\n parents: [data.ref.object.sha],\n });\n\n data.commit = commit.data;\n\n // push commit\n const push = await gh.request(`POST /repos/${owner}/${repo}/git/refs/heads/${branch}`, {\n sha: data.commit.sha,\n });\n\n data.push = push.data;\n return data;\n}",[],[219],{"_106":226,"_99":227,"_152":228,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":229,"_103":33,"_159":213,"_161":230,"_162":27,"_163":-5,"_164":231,"_102":232},"38f6dc36-ff86-11ef-ad47-569c3dd06744","config.json","929b3d8c-1384-4dc3-8901-2ea468468ce1",["D",1741813741761],"{\n \"owner\": \"jxnblk\",\n \"repo\": \"valtown-github-sync-v2\",\n \"branch\": \"refs/heads/main\",\n \"vals\": [\n \"GitHubSyncV2DemoVal\"\n ]\n}",[],[227],{"_106":234,"_99":235,"_152":118,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":236,"_103":33,"_159":237,"_161":238,"_162":27,"_163":-5,"_164":239,"_102":240},"38f6dd4e-ff86-11ef-ad47-569c3dd06744","index",["D",1741813741761],"http","/** @jsxImportSource npm:hono/jsx */\nimport { Hono } from \"npm:hono\";\nimport config from \"./config.json\" with { type: \"json\" };\nimport push from \"./routes/github-push\";\nimport Home from \"./routes/home\";\nimport deploy from \"./routes/valtown-deploy\";\nimport {\n //\n verifyGitHubSignature,\n verifyValSignature,\n} from \"./routes/middleware\";\n\nconst VAL_SECRET = Deno.env.get(\"VAL_SECRET\");\nconst GITHUB_WEBHOOK_SECRET = Deno.env.get(\"GITHUB_WEBHOOK_SECRET\");\n\nconst app = new Hono();\n\napp.get(\"/\", Home);\n\napp.post(\"/push\", verifyValSignature(VAL_SECRET), push);\n\napp.post(\"/deploy\", verifyGitHubSignature(GITHUB_WEBHOOK_SECRET), deploy);\n\nexport default app.fetch;",[],[235],{"_106":242,"_99":243,"_152":244,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":245,"_103":33,"_159":171,"_161":246,"_162":27,"_163":-5,"_164":247,"_102":248},"38f6df1a-ff86-11ef-ad47-569c3dd06744","sign-webhook","f643284d-e62b-4478-ab49-00f284a82617",["D",1741813741761],"/**\n * Use this function along with your valtown webhook secret to create\n * the x-val-signature header when posting to the /export webhook\n */\nexport const signWebhook = async (payload: unknown, secret: string) => {\n console.log(\"signWebhook\");\n const encoder = new TextEncoder();\n const key = await crypto.subtle.importKey(\n \"raw\",\n encoder.encode(secret),\n { name: \"HMAC\", hash: \"SHA-256\" },\n false,\n [\"sign\"],\n );\n console.log(\"signWebhook\", {\n payload,\n });\n const signature = await crypto.subtle.sign(\n \"HMAC\",\n key,\n encoder.encode(payload),\n );\n return Buffer.from(signature).toString(\"hex\");\n};\n\nexport default signWebhook;",[],[243],"files",[149,166,175,183,191,199,208,217,225,233,241],"counts",{"_253":33,"_254":137,"_255":33,"_256":257},"pulls","branches","forks","envVars",4,"contents",[260,263,266,269,272,275],{"_106":150,"_99":151,"_152":153,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":261,"_103":33,"_159":160,"_161":-5,"_162":27,"_163":-5,"_102":262},["D",1741813741761],[151],{"_106":209,"_99":210,"_152":211,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":264,"_103":33,"_159":213,"_161":214,"_162":27,"_163":-5,"_102":265},["D",1741813741761],[210],{"_106":218,"_99":219,"_152":220,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":267,"_103":33,"_159":171,"_161":222,"_162":27,"_163":-5,"_102":268},["D",1741813741761],[219],{"_106":226,"_99":227,"_152":228,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":270,"_103":33,"_159":213,"_161":230,"_162":27,"_163":-5,"_102":271},["D",1741813741761],[227],{"_106":234,"_99":235,"_152":118,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":273,"_103":33,"_159":237,"_161":238,"_162":27,"_163":-5,"_102":274},["D",1741813741761],[235],{"_106":242,"_99":243,"_152":244,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":276,"_103":33,"_159":171,"_161":246,"_162":27,"_163":-5,"_102":277},["D",1741813741761],[243],"upstream",{"_106":280,"_99":100,"_114":281,"_115":282,"_112":113,"_21":283},"7bc1183a-e562-11ef-8916-e6cdfca9ef9f","Sync vals to GitHub and back","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/04f460f2-d89d-4c98-9ae7-6e51f492cd00/square512",{"_97":284,"_133":285},"jxnblk","https://img.clerk.com/eyJ0eXBlIjoicHJveHkiLCJzcmMiOiJodHRwczovL2ltYWdlcy5jbGVyay5kZXYvb2F1dGhfZ2l0aHViL2ltZ18yZmtHZzA2Z3F0dEJXNHQ4S1hpYWdPZ0N0YU4ifQ","screenshots","emptyEnvVars","routes/_app.x.$handle.$name.code.$",{"_97":98,"_99":100,"_101":43,"_103":-7,"_102":70,"_104":290,"_147":294,"_249":328,"_213":-7,"_258":329,"_278":342,"_350":27,"_351":-5},{"_106":107,"_99":100,"_108":291,"_110":-5,"_111":27,"_112":113,"_114":-5,"_115":-5,"_12":116,"_117":118,"_119":120,"_121":-5,"_122":33,"_123":124,"_125":124,"_126":127,"_128":127,"_129":127,"_130":124,"_131":27,"_21":292,"_135":293},["D",1741813741761],{"_97":98,"_133":134},{"_103":137,"_99":43,"_106":138,"_139":107,"_140":141,"_142":143,"_144":113,"_145":146},[295,313,316,319,322,325],{"_106":150,"_99":151,"_152":153,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":158,"_103":33,"_159":160,"_161":-5,"_162":27,"_163":-5,"_164":296,"_102":312},[297,300,303,306,309],{"_106":167,"_99":168,"_152":169,"_154":153,"_155":138,"_156":137,"_157":120,"_108":170,"_103":33,"_159":171,"_161":172,"_162":27,"_163":-5,"_164":298,"_102":299},[],[151,168],{"_106":176,"_99":177,"_152":178,"_154":153,"_155":138,"_156":137,"_157":120,"_108":179,"_103":33,"_159":171,"_161":180,"_162":27,"_163":-5,"_164":301,"_102":302},[],[151,177],{"_106":184,"_99":185,"_152":186,"_154":153,"_155":138,"_156":137,"_157":120,"_108":187,"_103":33,"_159":171,"_161":188,"_162":27,"_163":-5,"_164":304,"_102":305},[],[151,185],{"_106":192,"_99":193,"_152":194,"_154":153,"_155":138,"_156":137,"_157":120,"_108":195,"_103":33,"_159":171,"_161":196,"_162":27,"_163":-5,"_164":307,"_102":308},[],[151,193],{"_106":200,"_99":201,"_152":202,"_154":153,"_155":138,"_156":137,"_157":120,"_108":203,"_103":33,"_159":171,"_161":204,"_162":27,"_163":-5,"_164":310,"_102":311},[],[151,201],[151],{"_106":209,"_99":210,"_152":211,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":212,"_103":33,"_159":213,"_161":214,"_162":27,"_163":-5,"_164":314,"_102":315},[],[210],{"_106":218,"_99":219,"_152":220,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":221,"_103":33,"_159":171,"_161":222,"_162":27,"_163":-5,"_164":317,"_102":318},[],[219],{"_106":226,"_99":227,"_152":228,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":229,"_103":33,"_159":213,"_161":230,"_162":27,"_163":-5,"_164":320,"_102":321},[],[227],{"_106":234,"_99":235,"_152":118,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":236,"_103":33,"_159":237,"_161":238,"_162":27,"_163":-5,"_164":323,"_102":324},[],[235],{"_106":242,"_99":243,"_152":244,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":245,"_103":33,"_159":171,"_161":246,"_162":27,"_163":-5,"_164":326,"_102":327},[],[243],[295,297,300,303,306,309,313,316,319,322,325],[330,332,334,336,338,340],{"_106":150,"_99":151,"_152":153,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":261,"_103":33,"_159":160,"_161":-5,"_162":27,"_163":-5,"_102":331},[151],{"_106":209,"_99":210,"_152":211,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":264,"_103":33,"_159":213,"_161":214,"_162":27,"_163":-5,"_102":333},[210],{"_106":218,"_99":219,"_152":220,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":267,"_103":33,"_159":171,"_161":222,"_162":27,"_163":-5,"_102":335},[219],{"_106":226,"_99":227,"_152":228,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":270,"_103":33,"_159":213,"_161":230,"_162":27,"_163":-5,"_102":337},[227],{"_106":234,"_99":235,"_152":118,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":273,"_103":33,"_159":237,"_161":238,"_162":27,"_163":-5,"_102":339},[235],{"_106":242,"_99":243,"_152":244,"_154":-5,"_155":138,"_156":137,"_157":120,"_108":276,"_103":33,"_159":171,"_161":246,"_162":27,"_163":-5,"_102":341},[243],{"_106":141,"_108":343,"_344":345,"_99":43,"_139":280,"_103":143,"_140":-5,"_142":-5,"_346":347,"_131":27,"_112":113,"_348":284,"_349":100},["D",1738939661756],"updatedAt",["D",1741127948569],"lockfileKey","1744484455387-esm.town_v_jxnblk_GitHubSync@179-main","userHandle","projectName","showCompareCallout","pull","routes/_app","actionData","errors"]

\n GitHubSync\n Sync vals from Val Town to GitHub and back\n

\n GitHubSync\n
Sync vals from Val Town to GitHub and back
\n