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

\n View source\n \n ,\n );\n}",[],[140,170],{"_102":179,"_95":180,"_141":181,"_143":142,"_144":132,"_145":182,"_147":148,"_104":183,"_99":184,"_151":164,"_153":185,"_154":26,"_155":186,"_98":187},"67b789cc-e58b-11ef-94ab-e6cdfca9ef9f","middleware","1214684e-e56f-11ef-a5a5-e6cdfca9ef9f",142,["D",1738957237500],24,"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};",[],[140,180],{"_102":189,"_95":190,"_141":191,"_143":142,"_144":132,"_145":192,"_147":148,"_104":193,"_99":194,"_151":164,"_153":195,"_154":26,"_155":196,"_98":197},"1afecca8-e56d-11ef-83c7-e6cdfca9ef9f","styles","e7baa34a-e56b-11ef-b737-e6cdfca9ef9f",44,["D",1738944223879],8,"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};",[],[140,190],{"_102":199,"_95":200,"_141":201,"_143":142,"_144":132,"_145":202,"_147":148,"_104":203,"_99":204,"_151":164,"_153":205,"_154":26,"_155":206,"_98":207},"b6d9515e-e58e-11ef-9bb7-e6cdfca9ef9f","valtown-deploy","31e417ca-e56d-11ef-b96f-e6cdfca9ef9f",158,["D",1738958658748],33,"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};",[],[140,200],[140],{"_102":210,"_95":211,"_141":115,"_143":-5,"_144":132,"_145":131,"_147":148,"_104":212,"_99":213,"_151":214,"_153":215,"_154":26,"_155":216,"_98":217},"5c478d92-e592-11ef-bac6-e6cdfca9ef9f","README.md",["D",1738960224789],38,"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",[],[211],{"_102":219,"_95":220,"_141":221,"_143":-5,"_144":132,"_145":222,"_147":148,"_104":223,"_99":224,"_151":164,"_153":225,"_154":26,"_155":226,"_98":227},"4301421c-e58b-11ef-903f-e6cdfca9ef9f","commit-files","a10a6c42-e56a-11ef-bef0-e6cdfca9ef9f",139,["D",1738957175908],6,"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}",[],[220],{"_102":229,"_95":230,"_141":231,"_143":-5,"_144":132,"_145":232,"_147":148,"_104":233,"_99":224,"_151":214,"_153":234,"_154":26,"_155":235,"_98":236},"ddffecaa-e581-11ef-b4c0-e6cdfca9ef9f","config.json","4dfa861c-e56b-11ef-9ffd-e6cdfca9ef9f",112,["D",1738953140978],"{\n \"owner\": \"jxnblk\",\n \"repo\": \"valtown-github-sync-v2\",\n \"branch\": \"refs/heads/main\",\n \"vals\": [\n \"GitHubSyncV2DemoVal\"\n ]\n}",[],[230],{"_102":238,"_95":239,"_141":240,"_143":-5,"_144":132,"_145":241,"_147":148,"_104":242,"_99":243,"_151":244,"_153":245,"_154":26,"_155":246,"_98":247},"69a9243e-e58b-11ef-a9ef-e6cdfca9ef9f","index","eb615ef4-e56a-11ef-b91b-e6cdfca9ef9f",143,["D",1738957240759],20,"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;",[],[239],{"_102":249,"_95":250,"_141":251,"_143":-5,"_144":132,"_145":252,"_147":148,"_104":253,"_99":174,"_151":164,"_153":254,"_154":26,"_155":255,"_98":256},"f659a620-e58a-11ef-bf7f-e6cdfca9ef9f","sign-webhook","36340550-e587-11ef-9c42-e6cdfca9ef9f",137,["D",1738957047304],"/**\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],"counts",{"_259":31,"_260":150,"_261":150,"_262":263},"pulls","branches","forks","envVars",4,"contents",[266,269,272,275,278,281],{"_102":139,"_95":140,"_141":142,"_143":-5,"_144":132,"_145":146,"_147":148,"_104":267,"_99":150,"_151":152,"_153":-5,"_154":26,"_98":268},["D",1738943921472],[140],{"_102":210,"_95":211,"_141":115,"_143":-5,"_144":132,"_145":131,"_147":148,"_104":270,"_99":213,"_151":214,"_153":215,"_154":26,"_98":271},["D",1738960224789],[211],{"_102":219,"_95":220,"_141":221,"_143":-5,"_144":132,"_145":222,"_147":148,"_104":273,"_99":224,"_151":164,"_153":225,"_154":26,"_98":274},["D",1738957175908],[220],{"_102":229,"_95":230,"_141":231,"_143":-5,"_144":132,"_145":232,"_147":148,"_104":276,"_99":224,"_151":214,"_153":234,"_154":26,"_98":277},["D",1738953140978],[230],{"_102":238,"_95":239,"_141":240,"_143":-5,"_144":132,"_145":241,"_147":148,"_104":279,"_99":243,"_151":244,"_153":245,"_154":26,"_98":280},["D",1738957240759],[239],{"_102":249,"_95":250,"_141":251,"_143":-5,"_144":132,"_145":252,"_147":148,"_104":282,"_99":174,"_151":164,"_153":254,"_154":26,"_98":283},["D",1738957047304],[250],"upstream","routes/_app.x.$handle.$name.environment-variables",{"_93":94,"_95":96,"_100":287,"_262":291},{"_102":103,"_95":96,"_104":288,"_106":-5,"_107":108,"_109":110,"_111":112,"_11":113,"_114":115,"_116":26,"_117":118,"_119":118,"_120":121,"_122":121,"_123":121,"_124":118,"_125":26,"_20":289,"_129":290},["D",1738939661756],{"_93":94,"_127":128},{"_99":131,"_95":41,"_102":132,"_133":103,"_134":-5,"_135":-5},[292,299,304,309],{"_293":294,"_104":295,"_296":-5,"_109":297,"_298":26},"key","VALTOWN_TOKEN",["D",1738958047911],"updatedAt","ValTown API token used to write updates from GitHub back to the source val (i.e. \"deploy\" from GitHub)","isEmpty",{"_293":300,"_104":301,"_296":302,"_109":303,"_298":26},"VAL_SECRET",["D",1738945415955],["D",1738954784225],"Secret for verifying webhook call to push val code to GitHub",{"_293":305,"_104":306,"_296":307,"_109":308,"_298":26},"GITHUB_TOKEN",["D",1738943029901],["D",1738954983077],"GitHub access token to allow this val to commit to the GitHub repository",{"_293":310,"_104":311,"_296":312,"_109":313,"_298":26},"GITHUB_WEBHOOK_SECRET",["D",1738942937867],["D",1738954770045],"Secret shared with GitHub to validate the incoming GitHub webhook","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

Environment variables

Used by this project