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

\n View source\n \n ,\n );\n}",[],[156,183],{"_102":190,"_95":191,"_157":192,"_159":158,"_160":138,"_161":162,"_163":116,"_104":193,"_99":32,"_165":177,"_167":194,"_168":22,"_169":-5,"_170":195,"_98":196},"08cebdfc-07ed-11f0-9591-569c3dd06744","middleware","f0bb13c0-36d2-42f6-b9b8-c40dd06f06d6",["D",1742737508430],"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};",[],[156,191],{"_102":198,"_95":199,"_157":200,"_159":158,"_160":138,"_161":162,"_163":116,"_104":201,"_99":32,"_165":177,"_167":202,"_168":22,"_169":-5,"_170":203,"_98":204},"08cec018-07ed-11f0-9591-569c3dd06744","styles","ef2de927-d219-42c4-a7a8-e0ae62bc6fe9",["D",1742737508430],"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};",[],[156,199],{"_102":206,"_95":207,"_157":208,"_159":158,"_160":138,"_161":209,"_163":116,"_104":210,"_99":162,"_165":177,"_167":211,"_168":22,"_169":-5,"_170":212,"_98":213},"c28368c4-07ed-11f0-8932-569c3dd06744","valtown-deploy","bffce9be-f7ba-4079-b364-6a138196f34f",2,["D",1742737820039],"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\");\n//const VALTOWN_TOKEN = Deno.env.get(\"VALTOWN_TOKEN\");\nconst VALTOWN_TOKEN = Deno.env.get('valtown')\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};",[],[156,207],[156],{"_102":216,"_95":217,"_157":218,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":219,"_99":32,"_165":220,"_167":221,"_168":22,"_169":-5,"_170":222,"_98":223},"08ced972-07ed-11f0-9591-569c3dd06744","README.md","27b4d82d-aff1-4bfc-86ae-8c04a35b8dc1",["D",1742737508430],"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",[],[217],{"_102":225,"_95":226,"_157":227,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":228,"_99":32,"_165":177,"_167":229,"_168":22,"_169":-5,"_170":230,"_98":231},"08cee0ac-07ed-11f0-9591-569c3dd06744","commit-files","178aed74-178e-4fcb-8017-f02aeb0e7b7f",["D",1742737508430],"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}",[],[226],{"_102":233,"_95":234,"_157":235,"_159":-5,"_160":138,"_161":137,"_163":116,"_104":236,"_99":209,"_165":220,"_167":237,"_168":22,"_169":-5,"_170":238,"_98":239},"f31f4250-07ed-11f0-8850-569c3dd06744","config.json","4adac7d1-af22-4cd7-be4f-59fa295a0d6e",["D",1742737901591],"{\n \"owner\": \"tionis\",\n \"repo\": \"vals\",\n \"branch\": \"refs/heads/main\",\n \"vals\": [\n \"hnFollow\"\n ]\n}",[],[234],{"_102":241,"_95":242,"_157":114,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":243,"_99":32,"_165":244,"_167":245,"_168":22,"_169":-5,"_170":246,"_98":247},"08cee4a8-07ed-11f0-9591-569c3dd06744","index",["D",1742737508430],"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;",[],[242],{"_102":249,"_95":250,"_157":251,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":252,"_99":32,"_165":177,"_167":253,"_168":22,"_169":-5,"_170":254,"_98":255},"08cee638-07ed-11f0-9591-569c3dd06744","sign-webhook","c73a03e3-2e6c-4c3c-9c8f-4137371791aa",["D",1742737508430],"/**\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;",[],[250],"files",[154,172,181,189,197,205,215,224,232,240,248],"counts",{"_260":32,"_261":162,"_262":32,"_263":264},"pulls","branches","forks","envVars",{"_265":266,"_267":32},"count",3,"emptyCount","contents",[270,273,276,279,282,285],{"_102":155,"_95":156,"_157":158,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":271,"_99":32,"_165":166,"_167":-5,"_168":22,"_169":-5,"_98":272},["D",1742737508430],[156],{"_102":216,"_95":217,"_157":218,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":274,"_99":32,"_165":220,"_167":221,"_168":22,"_169":-5,"_98":275},["D",1742737508430],[217],{"_102":225,"_95":226,"_157":227,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":277,"_99":32,"_165":177,"_167":229,"_168":22,"_169":-5,"_98":278},["D",1742737508430],[226],{"_102":233,"_95":234,"_157":235,"_159":-5,"_160":138,"_161":137,"_163":116,"_104":280,"_99":209,"_165":220,"_167":237,"_168":22,"_169":-5,"_98":281},["D",1742737901591],[234],{"_102":241,"_95":242,"_157":114,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":283,"_99":32,"_165":244,"_167":245,"_168":22,"_169":-5,"_98":284},["D",1742737508430],[242],{"_102":249,"_95":250,"_157":251,"_159":-5,"_160":138,"_161":162,"_163":116,"_104":286,"_99":32,"_165":177,"_167":253,"_168":22,"_169":-5,"_98":287},["D",1742737508430],[250],"upstreamProject",{"_102":146,"_95":96,"_110":290,"_111":291,"_108":109,"_23":292},"Sync vals to GitHub and back","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/04f460f2-d89d-4c98-9ae7-6e51f492cd00/square512",{"_93":293,"_130":294},"jxnblk","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/fca87e60-4ad1-453c-af10-2782c6823400/square512","upstreamBranch",{"_102":141,"_104":297,"_298":299,"_95":43,"_139":146,"_99":143,"_140":-5,"_142":-5,"_300":301,"_106":-5,"_151":22,"_108":109,"_150":293,"_16":148,"_149":96},["D",1738939661756],"updatedAt",["D",1741127948569],"lockfileKey","1744484455387-esm.town_v_jxnblk_GitHubSync@179-main","emptyEnvVars","isNew","flags",[],"routes/_app.x.$handle.$name.environment-variables",{"_93":94,"_95":96,"_100":308,"_263":313},{"_102":103,"_95":96,"_104":309,"_106":-5,"_107":22,"_108":109,"_110":-5,"_111":-5,"_14":112,"_113":114,"_115":116,"_117":-5,"_118":32,"_16":119,"_120":121,"_122":121,"_123":124,"_125":124,"_126":124,"_127":121,"_128":121,"_23":310,"_132":311,"_135":312,"_151":22},["D",1742737508430],{"_93":94,"_130":131},{"_93":94,"_134":131},{"_99":137,"_95":43,"_102":138,"_139":103,"_140":141,"_142":143,"_144":109,"_145":146,"_147":148,"_149":96,"_150":94},[314,321,326],{"_315":316,"_104":317,"_298":318,"_110":319,"_320":22},"key","GITHUB_TOKEN",["D",1742737508430],["D",1742737637113],"GitHub access token to allow this val to commit to the GitHub repository","isEmpty",{"_315":322,"_104":323,"_298":324,"_110":325,"_320":22},"GITHUB_WEBHOOK_SECRET",["D",1742737508430],["D",1742737731698],"Secret shared with GitHub to validate the incoming GitHub webhook",{"_315":327,"_104":328,"_298":329,"_110":330,"_320":22},"VAL_SECRET",["D",1742737508430],["D",1742737739399],"Secret for verifying webhook call to push val code to GitHub","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

tionis

GitHubSync

Environment variables