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

\n View source\n \n ,\n );\n}",[],[154,180],{"_105":187,"_98":188,"_155":189,"_157":156,"_158":138,"_159":137,"_160":119,"_107":190,"_102":29,"_162":174,"_164":191,"_165":25,"_166":-5,"_167":192,"_101":193},"8a671256-089c-11f0-9bb0-569c3dd06744","middleware","060457b3-485b-4314-9c8d-239756e3f934",["D",1742812887783],"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};",[],[154,188],{"_105":195,"_98":196,"_155":197,"_157":156,"_158":138,"_159":137,"_160":119,"_107":198,"_102":29,"_162":174,"_164":199,"_165":25,"_166":-5,"_167":200,"_101":201},"8a673632-089c-11f0-9bb0-569c3dd06744","styles","3ec71a6c-9414-40f5-a7a2-cb89a049f6f3",["D",1742812887783],"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};",[],[154,196],{"_105":203,"_98":204,"_155":205,"_157":156,"_158":138,"_159":137,"_160":119,"_107":206,"_102":29,"_162":174,"_164":207,"_165":25,"_166":-5,"_167":208,"_101":209},"8a673b32-089c-11f0-9bb0-569c3dd06744","valtown-deploy","ecc88836-8a6e-4584-9998-b69678a124a5",["D",1742812887783],"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};",[],[154,204],[154],{"_105":212,"_98":213,"_155":214,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":215,"_102":29,"_162":216,"_164":217,"_165":25,"_166":-5,"_167":218,"_101":219},"8a67421c-089c-11f0-9bb0-569c3dd06744","README.md","58d4f790-1e5b-4bb4-9d5a-f1effc5b7fbf",["D",1742812887783],"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",[],[213],{"_105":221,"_98":222,"_155":223,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":224,"_102":29,"_162":174,"_164":225,"_165":25,"_166":-5,"_167":226,"_101":227},"8a6777aa-089c-11f0-9bb0-569c3dd06744","commit-files","bd09ac1d-5b13-4010-82c5-17d12a492f98",["D",1742812887783],"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}",[],[222],{"_105":229,"_98":230,"_155":231,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":232,"_102":29,"_162":216,"_164":233,"_165":25,"_166":-5,"_167":234,"_101":235},"8a6779bc-089c-11f0-9bb0-569c3dd06744","config.json","f7e3e1bd-f4a6-4c9d-8c87-a75f3fc278e6",["D",1742812887783],"{\n \"owner\": \"jxnblk\",\n \"repo\": \"valtown-github-sync-v2\",\n \"branch\": \"refs/heads/main\",\n \"vals\": [\n \"GitHubSyncV2DemoVal\"\n ]\n}",[],[230],{"_105":237,"_98":238,"_155":117,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":239,"_102":29,"_162":240,"_164":241,"_165":25,"_166":-5,"_167":242,"_101":243},"8a677c0a-089c-11f0-9bb0-569c3dd06744","index",["D",1742812887783],"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;",[],[238],{"_105":245,"_98":246,"_155":247,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":248,"_102":29,"_162":174,"_164":249,"_165":25,"_166":-5,"_167":250,"_101":251},"8a677d18-089c-11f0-9bb0-569c3dd06744","sign-webhook","b44a3326-1b27-4c51-b3c7-1bc651979a44",["D",1742812887783],"/**\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;",[],[246],"files",[152,169,178,186,194,202,211,220,228,236,244],"counts",{"_256":29,"_257":137,"_258":29,"_259":260},"pulls","branches","forks","envVars",4,"contents",[263,266,269,272,275,278],{"_105":153,"_98":154,"_155":156,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":264,"_102":29,"_162":163,"_164":-5,"_165":25,"_166":-5,"_101":265},["D",1742812887783],[154],{"_105":212,"_98":213,"_155":214,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":267,"_102":29,"_162":216,"_164":217,"_165":25,"_166":-5,"_101":268},["D",1742812887783],[213],{"_105":221,"_98":222,"_155":223,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":270,"_102":29,"_162":174,"_164":225,"_165":25,"_166":-5,"_101":271},["D",1742812887783],[222],{"_105":229,"_98":230,"_155":231,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":273,"_102":29,"_162":216,"_164":233,"_165":25,"_166":-5,"_101":274},["D",1742812887783],[230],{"_105":237,"_98":238,"_155":117,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":276,"_102":29,"_162":240,"_164":241,"_165":25,"_166":-5,"_101":277},["D",1742812887783],[238],{"_105":245,"_98":246,"_155":247,"_157":-5,"_158":138,"_159":137,"_160":119,"_107":279,"_102":29,"_162":174,"_164":249,"_165":25,"_166":-5,"_101":280},["D",1742812887783],[246],"upstreamProject",{"_105":283,"_98":99,"_113":284,"_114":285,"_111":112,"_19":286},"7bc1183a-e562-11ef-8916-e6cdfca9ef9f","Sync vals to GitHub and back","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/04f460f2-d89d-4c98-9ae7-6e51f492cd00/square512",{"_96":287,"_133":288},"jxnblk","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/fca87e60-4ad1-453c-af10-2782c6823400/square512","upstreamBranch",{"_105":141,"_107":291,"_292":293,"_98":40,"_139":283,"_102":143,"_140":-5,"_142":-5,"_294":295,"_109":-5,"_149":25,"_111":112,"_148":287,"_14":296,"_147":99},["D",1738939661756],"updatedAt",["D",1741127948569],"lockfileKey","1744484455387-esm.town_v_jxnblk_GitHubSync@179-main","62a75f8d-be32-4eaa-989a-23f3433a7d42","emptyEnvVars","isNew","routes/_app.x.$handle.$name.branch.$branch.history",{"_96":97,"_98":99,"_100":40,"_103":301,"_305":306,"_342":29,"_343":25},{"_105":106,"_98":99,"_107":302,"_109":-5,"_110":25,"_111":112,"_113":-5,"_114":-5,"_12":115,"_116":117,"_118":119,"_120":-5,"_121":29,"_14":122,"_123":124,"_125":124,"_126":127,"_128":127,"_129":127,"_130":124,"_131":124,"_19":303,"_135":304,"_149":25},["D",1742812887783],{"_96":97,"_133":134},{"_102":137,"_98":40,"_105":138,"_139":106,"_140":141,"_142":143,"_144":112,"_145":146,"_147":99,"_148":97},"history",[307],{"_155":223,"_102":137,"_107":308,"_158":138,"_252":309},["D",1742812887783],[310,312,315,318,321,324,327,330,333,336,339],{"_105":221,"_158":138,"_155":223,"_98":222,"_164":225,"_162":174,"_102":29,"_157":-5,"_107":308,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":311},[222],{"_105":229,"_158":138,"_155":231,"_98":230,"_164":233,"_162":216,"_102":29,"_157":-5,"_107":313,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":314},["D",1742812887783],[230],{"_105":170,"_158":138,"_155":172,"_98":171,"_164":175,"_162":174,"_102":29,"_157":156,"_107":316,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":317},["D",1742812887783],[154,171],{"_105":179,"_158":138,"_155":181,"_98":180,"_164":183,"_162":174,"_102":29,"_157":156,"_107":319,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":320},["D",1742812887783],[154,180],{"_105":237,"_158":138,"_155":117,"_98":238,"_164":241,"_162":240,"_102":29,"_157":-5,"_107":322,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":323},["D",1742812887783],[238],{"_105":187,"_158":138,"_155":189,"_98":188,"_164":191,"_162":174,"_102":29,"_157":156,"_107":325,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":326},["D",1742812887783],[154,188],{"_105":212,"_158":138,"_155":214,"_98":213,"_164":217,"_162":216,"_102":29,"_157":-5,"_107":328,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":329},["D",1742812887783],[213],{"_105":153,"_158":138,"_155":156,"_98":154,"_164":-5,"_162":163,"_102":29,"_157":-5,"_107":331,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":332},["D",1742812887783],[154],{"_105":245,"_158":138,"_155":247,"_98":246,"_164":249,"_162":174,"_102":29,"_157":-5,"_107":334,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":335},["D",1742812887783],[246],{"_105":195,"_158":138,"_155":197,"_98":196,"_164":199,"_162":174,"_102":29,"_157":156,"_107":337,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":338},["D",1742812887783],[154,196],{"_105":203,"_158":138,"_155":205,"_98":204,"_164":207,"_162":174,"_102":29,"_157":156,"_107":340,"_159":137,"_166":-5,"_160":119,"_165":25,"_101":341},["D",1742812887783],[154,204],"page","hasNext","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

History