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

\n View source\n \n ,\n );\n}",[],[146,173],{"_103":180,"_95":181,"_147":182,"_149":148,"_150":133,"_151":132,"_152":153,"_105":183,"_100":31,"_155":167,"_157":184,"_158":27,"_159":-5,"_160":185,"_98":186},"cb26656c-3b1e-11f0-b422-9e149126039e","middleware","39fe72bc-51e4-4b8b-8d32-b9f9737e48d0",["D",1748366389144],"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};",[],[146,181],{"_103":188,"_95":189,"_147":190,"_149":148,"_150":133,"_151":132,"_152":153,"_105":191,"_100":31,"_155":167,"_157":192,"_158":27,"_159":-5,"_160":193,"_98":194},"cb266bf2-3b1e-11f0-b422-9e149126039e","styles","835063dd-cfc7-4a63-8b17-334b821623ad",["D",1748366389144],"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};",[],[146,189],{"_103":196,"_95":197,"_147":198,"_149":148,"_150":133,"_151":132,"_152":153,"_105":199,"_100":31,"_155":167,"_157":200,"_158":27,"_159":-5,"_160":201,"_98":202},"cb266dfa-3b1e-11f0-b422-9e149126039e","valtown-deploy","92b26067-fd75-40a3-b185-ec2613752abe",["D",1748366389144],"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};",[],[146,197],[146],{"_103":205,"_95":206,"_147":207,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":208,"_100":31,"_155":209,"_157":210,"_158":27,"_159":-5,"_160":211,"_98":212},"cb26791c-3b1e-11f0-b422-9e149126039e","README.md","d224213e-6cbb-4c82-8b75-caf49b097bcd",["D",1748366389144],"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",[],[206],{"_103":214,"_95":215,"_147":216,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":217,"_100":31,"_155":167,"_157":218,"_158":27,"_159":-5,"_160":219,"_98":220},"cb2680f6-3b1e-11f0-b422-9e149126039e","commit-files","c80d85d0-420c-4193-b964-827f1fd5fa6d",["D",1748366389144],"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}",[],[215],{"_103":222,"_95":223,"_147":224,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":225,"_100":31,"_155":209,"_157":226,"_158":27,"_159":-5,"_160":227,"_98":228},"cb2682ae-3b1e-11f0-b422-9e149126039e","config.json","7ed1158b-5319-4b46-94e6-effeb858a026",["D",1748366389144],"{\n \"owner\": \"jxnblk\",\n \"repo\": \"valtown-github-sync-v2\",\n \"branch\": \"refs/heads/main\",\n \"vals\": [\n \"GitHubSyncV2DemoVal\"\n ]\n}",[],[223],{"_103":230,"_95":99,"_147":231,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":232,"_100":31,"_155":233,"_157":234,"_158":27,"_159":-5,"_160":235,"_98":236},"cb268452-3b1e-11f0-b422-9e149126039e","cd2ee917-9bfe-4190-8791-67104bfc1be6",["D",1748366389144],"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;",[],[99],{"_103":238,"_95":239,"_147":240,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":241,"_100":31,"_155":167,"_157":242,"_158":27,"_159":-5,"_160":243,"_98":244},"cb26861e-3b1e-11f0-b422-9e149126039e","sign-webhook","de3896f5-db6e-43ff-8cb9-1f0420185c66",["D",1748366389144],"/**\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;",[],[239],"files",[144,162,171,179,187,195,204,213,221,229,237],"counts",{"_249":31,"_250":132,"_251":31,"_252":253},"pulls","branches","forks","envVars",4,"contents",[],{"_103":230,"_95":99,"_147":231,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":257,"_100":31,"_155":233,"_157":234,"_158":27,"_159":-5,"_98":258},["D",1748366389144],[99],"upstream",{"_103":261,"_95":96,"_111":262,"_112":263,"_109":110,"_21":264},"7bc1183a-e562-11ef-8916-e6cdfca9ef9f","Sync vals to GitHub and back","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/04f460f2-d89d-4c98-9ae7-6e51f492cd00/square512",{"_93":265,"_128":266},"jxnblk","https://img.clerk.com/eyJ0eXBlIjoicHJveHkiLCJzcmMiOiJodHRwczovL2ltYWdlcy5jbGVyay5kZXYvb2F1dGhfZ2l0aHViL2ltZ18yZmtHZzA2Z3F0dEJXNHQ4S1hpYWdPZ0N0YU4ifQ","emptyEnvVars","isNew","routes/_app.x.$handle.$name.code.$",{"_93":94,"_95":96,"_97":41,"_100":-7,"_98":99,"_101":271,"_142":275,"_245":309,"_209":310,"_254":312,"_259":313,"_321":27,"_322":-5},{"_103":104,"_95":96,"_105":272,"_107":-5,"_108":27,"_109":110,"_111":-5,"_112":-5,"_12":113,"_114":-5,"_115":27,"_116":-5,"_117":31,"_118":119,"_120":119,"_121":122,"_123":122,"_124":122,"_125":119,"_126":27,"_21":273,"_130":274},["D",1748366389144],{"_93":94,"_128":129},{"_100":132,"_95":41,"_103":133,"_134":104,"_135":136,"_137":138,"_139":110,"_140":141},[276,294,297,300,303,306],{"_103":145,"_95":146,"_147":148,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":154,"_100":31,"_155":156,"_157":-5,"_158":27,"_159":-5,"_160":277,"_98":293},[278,281,284,287,290],{"_103":163,"_95":164,"_147":165,"_149":148,"_150":133,"_151":132,"_152":153,"_105":166,"_100":31,"_155":167,"_157":168,"_158":27,"_159":-5,"_160":279,"_98":280},[],[146,164],{"_103":172,"_95":173,"_147":174,"_149":148,"_150":133,"_151":132,"_152":153,"_105":175,"_100":31,"_155":167,"_157":176,"_158":27,"_159":-5,"_160":282,"_98":283},[],[146,173],{"_103":180,"_95":181,"_147":182,"_149":148,"_150":133,"_151":132,"_152":153,"_105":183,"_100":31,"_155":167,"_157":184,"_158":27,"_159":-5,"_160":285,"_98":286},[],[146,181],{"_103":188,"_95":189,"_147":190,"_149":148,"_150":133,"_151":132,"_152":153,"_105":191,"_100":31,"_155":167,"_157":192,"_158":27,"_159":-5,"_160":288,"_98":289},[],[146,189],{"_103":196,"_95":197,"_147":198,"_149":148,"_150":133,"_151":132,"_152":153,"_105":199,"_100":31,"_155":167,"_157":200,"_158":27,"_159":-5,"_160":291,"_98":292},[],[146,197],[146],{"_103":205,"_95":206,"_147":207,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":208,"_100":31,"_155":209,"_157":210,"_158":27,"_159":-5,"_160":295,"_98":296},[],[206],{"_103":214,"_95":215,"_147":216,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":217,"_100":31,"_155":167,"_157":218,"_158":27,"_159":-5,"_160":298,"_98":299},[],[215],{"_103":222,"_95":223,"_147":224,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":225,"_100":31,"_155":209,"_157":226,"_158":27,"_159":-5,"_160":301,"_98":302},[],[223],{"_103":230,"_95":99,"_147":231,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":232,"_100":31,"_155":233,"_157":234,"_158":27,"_159":-5,"_160":304,"_98":305},[],[99],{"_103":238,"_95":239,"_147":240,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":241,"_100":31,"_155":167,"_157":242,"_158":27,"_159":-5,"_160":307,"_98":308},[],[239],[276,278,281,284,287,290,294,297,300,303,306],{"_103":230,"_95":99,"_147":231,"_149":-5,"_150":133,"_151":132,"_152":153,"_105":257,"_100":31,"_155":233,"_157":234,"_158":27,"_159":-5,"_98":311},[99],[],{"_103":136,"_105":314,"_315":316,"_95":41,"_134":261,"_100":138,"_135":-5,"_137":-5,"_317":318,"_126":27,"_109":110,"_319":265,"_320":96},["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