[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_162":163,"_164":165},"routes/_app.x.$handle.$name",{"_98":97,"_32":49,"_106":88,"_27":107,"_13":14,"_108":-5,"_11":109,"_110":111,"_112":113,"_114":115,"_116":117,"_21":-5,"_118":-5,"_119":-5,"_120":25,"_121":122,"_123":53,"_124":-5,"_125":-5,"_126":127},"routes/_app.x.$handle.$name.branch.$branch.version.$version.diff",{"_11":12,"_13":14,"_15":16,"_17":-5,"_18":-5},"project",{"_47":48,"_32":49,"_36":50,"_51":-5,"_52":53,"_54":55,"_56":55,"_57":-5,"_58":-5,"_18":59,"_60":43,"_61":53,"_62":-5,"_63":-5,"_64":65,"_66":67,"_68":-5,"_69":-5,"_70":-5,"_71":-5,"_72":73,"_74":73,"_75":76,"_77":76,"_78":76,"_79":73,"_80":73,"_81":82,"_83":84,"_85":86,"_87":25},"version",1,"changes",[19,20],"aiChatInfo","userId",{"_21":41,"_23":-7,"_24":25,"_26":25,"_27":42,"_29":42},{"_21":22,"_23":-7,"_24":25,"_26":25,"_27":28,"_29":28},"file",{"_30":31,"_32":28,"_33":21,"_34":35,"_36":37,"_38":14,"_39":40,"_24":25},"previous","deleted",false,"deletedHere","path","README.md","latestPath","fileId","ffbe1f12-2792-11f0-9d52-569c3dd06744","name","fileType","content","# GitHub Sync\n\nSync vals from Val Town to GitHub and back\n\n## What it does\n\nUsing a fork of this val, you can specify a list of your own vals to export to a GitHub repo.\nLog in to the web app rendered by this val to manually click the _Export_ button,\nwhich will read the contents of your vals and commit those vals as files to your GitHub repo.\n\nIf you set up your repo to use the webhook in this val, any changes pushed to the GitHub repo\nwill be synced back to the vals in your list.\n\n## How to use\n\n1. Fork this val\n1. Create a new repo on GitHub for syncing your vals to (it can be public or private as long as you use the appropriate token scope)\n1. Add a webhook to your repo that points to your val's `/webhook` route, e.g. `https://jxnblk-githubsync.web.val.run/webhook`\n1. Create a _Secret_ for your webhook\n1. In your [Val Town Settings][env vars], add that same secret as `GHSYNC_WEBHOOK_SECRET`\n1. On GitHub, create a new [GitHub OAuth app][]\n - Use your val's web URL for the _Homepage URL_\n - Set your val's `/auth` route as the _Authorization callback URL_, e.g. `https://jxnblk-githubsync.web.val.run/auth`\n - Copy your new OAuth app's _Client ID_ and add that as the `GHSYNC_CLIENT_ID` env var in Val Town\n - Create and copy a _Client Secret_ and add that as the `GHSYNC_CLIENT_SECRET` env var in Val Town\n1. On GitHub, create a new personal [access token][github access token]\n - Ensure the token has read access to _Contents_ for your repo\n - Copy the access token and add that as the `GHSYNC_GITHUB_TOKEN` env var in Val Town\n1. In your val, edit the `config` in the val to point to your repo's `owner` and `repo`\n1. Edit the `valNames` list to include the name of the vals you'd like to sync to the repo\n1. In your val's _Settings_, ensure that under _Permissions_, _Vals_ has _Read & Write_ access\n1. Open your val's web URL in a new tab and click _Log in with GitHub_\n1. You should see a page listing your vals to be exported and the GitHub repo to sync to (if not, [see below][troubleshooting])\n1. Click the _Export_ button to sync your vals to the GitHub repo. This can take a moment and you'll need to wait for the browser request to complete.\n1. Once your vals are in the GitHub repo, edit them on GitHub or push changes to ensure that the webhook is working.\n You can check the _Requests_ and _Logs_ tabs for your val to debug any errors\n\n## Demo\n\n- This val is synced to GitHub: [gitHubSyncDemoVal][demo val]\n- This is the GitHub repo: [jxnblk/valtown-github-sync][demo repo]\n\n## Troubleshooting\n\n- If after logging in, you see a _How to use GitHub Sync_ page,\n ensure that the `config.owner` in your val matches your GitHub username\n- If the webhook doesn't work, ensure you have the webhook properly configured\n in the GitHub repo and that the `GHSYNC_WEBHOOK_SECRET` env var in Val Town\n matches the value in your GitHub repo.\n\n## Additional Features\n\nThe following list are ideas for how to improve this val.\nFeel free to implement some of these ideas.\nI would consider accepting pull requests for these features.\n\n- [ ] Check timestamps on Val Town and GitHub to prevent syncing when an older version would overwrite a newer one\n- [ ] Add an authenticated webhook to sync from Val Town to GitHub (e.g. a Cron val could trigger export to keep vals synced)\n- [ ] A \"No-UI\" version of this will only webhooks (authentication would need to be considered)\n\n[env vars]: https://www.val.town/settings/environment-variables\n[github oauth app]: https://github.com/settings/developers\n[github access token]: https://github.com/settings/tokens\n[troubleshooting]: #troubleshooting\n\n[demo repo]: https://github.com/jxnblk/valtown-github-sync\n[demo val]: https://val.town/v/jxnblk/gitHubSyncDemoVal\n\nMigrated from folder: ExamplesAndForks/gitHubSync","createdAt",["D",1734558670888],"branchVersion","branchId","ffb8b84c-2792-11f0-9d52-569c3dd06744",{"_30":43,"_32":42,"_33":44,"_34":45,"_36":46,"_38":14,"_39":40,"_24":25},"main.tsx","ffbe117a-2792-11f0-9d52-569c3dd06744","http","/** @jsxImportSource npm:hono/jsx */\nimport { ValTown } from \"npm:@valtown/sdk\";\nimport { Hono } from \"npm:hono\";\nimport { getCookie, setCookie } from \"npm:hono/cookie\";\n\nimport { decodeBase64 } from \"jsr:@std/encoding/base64\";\nimport { Octokit } from \"npm:@octokit/rest\";\nimport { Webhooks } from \"npm:@octokit/webhooks\";\n\ntype Config = {\n owner: string;\n repo: string;\n valNames: string[];\n};\n\n/**\n * Configuration\n * If you fork this val, edit the following config\n * to point to your GitHub repo and add your list of vals\n */\nconst config: Config = {\n owner: \"jxnblk\",\n repo: \"valtown-github-sync\",\n valNames: [\n \"gitHubSyncDemoVal\",\n ],\n};\n\n/**\n * Environment Variables\n * If you fork this val, ensure you set the following\n * environment variables in your Val Town account\n * https://val.town/settings/environment-variables\n */\nconst client_id = Deno.env.get(\"GHSYNC_CLIENT_ID\");\nconst client_secret = Deno.env.get(\"GHSYNC_CLIENT_SECRET\");\nconst webhook_secret = Deno.env.get(\"GHSYNC_WEBHOOK_SECRET\")!!;\nconst github_token = Deno.env.get(\"GHSYNC_GITHUB_TOKEN\");\n\n/**\n * If you fork this val, no further edits should be required below\n */\n\nconst oauthURL = `https://github.com/login/oauth/authorize?scope=user:email,repo&client_id=${client_id}`;\n\nconst FILE = \"100644\";\nconst FOLDER = \"040000\";\nconst PERMALINK = \"https://val.town/v/jxnblk/gitHubSync\";\n\nconst valtown = new ValTown();\nconst webhooks = new Webhooks({ secret: webhook_secret });\nconst app = new Hono();\n\napp.get(\"/\", async (c) => {\n const sesh = getCookie(c, \"gh_session\");\n\n if (sesh) return c.redirect(\"/app\");\n\n return c.html(\n \n \n );\n}\n\nfunction Logout() {\n return (\n \n );\n}\n\nexport default app.fetch;\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\n/**\n * This function can be used on its own\n * to commit multiple files to a GitHub repo\n */\nexport async function commitFiles({\n token,\n owner,\n repo,\n files,\n branch = \"main\",\n message = \"published with jxnblk/GHCommit\",\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}",["D",1734558670888],"id","ffb87a26-2792-11f0-9d52-569c3dd06744","gitHubSync",["D",1746217275745],"deletedAt","legacyEnvVars",true,"privacy","public","httpPrivacy","description","imageUrl","a8270e74-6479-475a-8025-9b69544ee0e7","pinnedFileId","pinPreview","pinMigrated","screenshotVersion","likeCount",0,"orgId","8319defa-6e1a-46d4-ba66-2114ffd3360b","tursoName","tursoHostname","tursoMeasuredAt","pinned","userPerm","r","valPerm","blobPerm","rw","emailPerm","sqlitePerm","projectPerm","telemetryPerm","user",{"_98":97,"_105":101},"org",{"_98":97,"_99":-5,"_100":101,"_18":59,"_102":103,"_104":25},"branch",{"_13":14,"_32":88,"_47":40,"_89":48,"_90":-5,"_91":-5,"_92":-5,"_93":-5,"_94":-5,"_95":49,"_96":97},"isOwned","main","projectId","forkedBranchId","forkedBranchVersion","forkedProjectPrivacy","forkedProjectId","forkedProjectOrgId","projectName","userHandle","yawnxyz","handle","displayName","avatar","https://images.clerk.dev/oauth_github/img_2NnaHhpxNuH1xWRIRjQNoo16TVc.jpeg","tier","pro","canRestrictVals","profileImageUrl","branchName","","adoptOrgId",{"_47":48,"_32":49,"_36":158,"_51":-5,"_52":53,"_54":55,"_56":55,"_57":-5,"_58":-5,"_18":59,"_60":43,"_61":53,"_62":-5,"_63":-5,"_64":65,"_66":67,"_68":-5,"_69":-5,"_70":-5,"_71":-5,"_72":73,"_74":73,"_75":76,"_77":76,"_78":76,"_79":73,"_80":73,"_81":159,"_83":160,"_85":161,"_87":25},"tree",[149,150],"files",[149,150],"counts",{"_139":65,"_140":14,"_141":65,"_142":143,"_144":145},"contents",[128,129],"upstreamProject","upstreamBranch","emptyEnvVars","flags",[],"hasHttpFiles","grants","orgs","customDomains",{},{"_47":136,"_32":28,"_30":31,"_131":-5,"_39":40,"_38":14,"_132":53,"_36":137,"_13":65,"_33":21,"_34":35,"_24":25,"_134":-5,"_27":138},{"_47":130,"_32":42,"_30":43,"_131":-5,"_39":40,"_38":14,"_132":53,"_36":133,"_13":65,"_33":44,"_34":45,"_24":25,"_134":-5,"_27":135},"ffbe10bc-2792-11f0-9d52-569c3dd06744","parentId","latest",["D",1734558670888],"label",[42],"ffbe1e7c-2792-11f0-9d52-569c3dd06744",["D",1734558670888],[28],"pulls","branches","forks","envVars",{"_146":65,"_148":65},"connections",{"_146":65,"_147":65},"count","unfilledCount","emptyCount",{"_47":136,"_32":28,"_30":31,"_131":-5,"_39":40,"_38":14,"_132":53,"_36":155,"_13":65,"_33":21,"_34":35,"_24":25,"_134":-5,"_152":156,"_27":157},{"_47":130,"_32":42,"_30":43,"_131":-5,"_39":40,"_38":14,"_132":53,"_36":151,"_13":65,"_33":44,"_34":45,"_24":25,"_134":-5,"_152":153,"_27":154},["D",1734558670888],"children",[],[42],["D",1734558670888],[],[28],["D",1746217275745],{"_98":97,"_105":101},{"_98":97,"_99":-5,"_100":101,"_18":59,"_102":103,"_104":25},{"_13":14,"_32":88,"_47":40,"_89":48,"_90":-5,"_91":-5,"_92":-5,"_93":-5,"_94":-5,"_95":49,"_96":97},"ctx",{"_81":-5,"_125":195,"_196":197,"_198":199,"_200":25,"_201":25,"_202":25,"_203":53,"_204":-5,"_205":-7,"_206":-7,"_207":65,"_208":25,"_209":25,"_210":-5,"_211":25,"_212":25,"_213":25,"_214":-5},"ENV",{"_166":167,"_168":169,"_170":88,"_171":172,"_173":174,"_175":176,"_177":178,"_179":180,"_181":182,"_183":184,"_185":186,"_187":188,"_189":190,"_191":192,"_193":194},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","e87eb04e707cf64e7e532c8e8ec395f209e17f15","RENDER_GIT_BRANCH","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","CLOUDFLARE_TURNSTILE_SITE_KEY","0x4AAAAAACtaIZJH7s9rBMZ6","GOOGLE_CLIENT_ID","875989696899-jtsqkhlbdv5jrlsk8631p7ipjg3c6o62.apps.googleusercontent.com","STRIPE_PUBLISHABLE_KEY","pk_live_51N2zvWEpZTTLipIkVEwXrUG9AT0yeOOEYxszarZT1jpsZV58Ly6wlg3SltZpHN26CUalOBmUSY7adQRQiSkCZz2500qSXNkf8Y","API_URL","https://api.val.town",[],"preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","preferencesCloseBrackets","preferencesChatPanelState","preferencesDprint","preferencesDenofmt","notificationCount","flagDenols","isBusinessOrgMember","businessOrgHandle","isBusinessOrgAdmin","isHigherTownieTier","navCollapsed","currentOrgId"]

Diff · v1