2d:null 2e:["$","title",null,{"children":"GitHub API Helpers | Shana Matthews | Observable"}] 33:[{"id":"19a1529f7d245aa6b6d87a1aee5a2f7525c2a246f37b2755301ac810cb23d3f898a6d84d597ca169b5554a2dfab58838e4d7bac231f353d8b9eb16e917a2f79d","href":"https://static.observableusercontent.com/files/19a1529f7d245aa6b6d87a1aee5a2f7525c2a246f37b2755301ac810cb23d3f898a6d84d597ca169b5554a2dfab58838e4d7bac231f353d8b9eb16e917a2f79d","name":"workflows@1.json","type":"application/json","lastModified":1698959017798.387,"size":392},{"id":"831f9c8418cde7376047477a4e6bf4676970ccc48dc8886c289632e45ead5013595dc250d4ea592530797da47b3634383b433b2f8b3cdbf356345a81d458e308","href":"https://static.observableusercontent.com/files/831f9c8418cde7376047477a4e6bf4676970ccc48dc8886c289632e45ead5013595dc250d4ea592530797da47b3634383b433b2f8b3cdbf356345a81d458e308","name":"runs.json","type":"application/json","lastModified":1698959017798.387,"size":2144657}] 31:{"id":"4ed285fd24406e30","slug":"github-api-helpers","title":"GitHub API Helpers","thumbnail":"c73b2013e2088aa778496890cefd1ebc66e546cb8f130842b804cc413e90925d","access_level":"public","create_time":"$D2023-11-02T21:03:37.798Z","update_time":"$D2023-11-02T21:05:47.915Z","view_time":null,"first_public_time":"$D2023-11-02T21:03:37.798Z","has_unpublished_edits":null,"fork":{"id":"0c6cd2788537fd3e","slug":"github-actions-workflows-api","title":"GitHub API Helpers","owner":{"id":"f35c755083683fe5","login":"observablehq","name":"Observable"}},"stars":0,"starred":false,"owner":{"type":"team","id":"c2c4bf3817594e7a","login":"shanamatthews","name":"Shana Matthews","avatar_url":"https://avatars-next.observableusercontent.com/340ef6744a9ac2c729c6d78fcd6cba4605a6eb050c76e0528bc44eef6752a274","tier":"starter_2024"},"version":503,"publish_version":null,"role":null,"authored":false,"authors":[{"type":"individual","id":"543390bedabcfda6","login":"shanamatthews","name":"Shana Matthews","avatar_url":"https://avatars-next.observableusercontent.com/340ef6744a9ac2c729c6d78fcd6cba4605a6eb050c76e0528bc44eef6752a274","tier":null}],"members":[{"type":"individual","id":"543390bedabcfda6","login":"shanamatthews","name":"Shana Matthews","avatar_url":"https://avatars-next.observableusercontent.com/340ef6744a9ac2c729c6d78fcd6cba4605a6eb050c76e0528bc44eef6752a274","tier":null,"role":"editor"}],"comments":[],"custom_thumbnail":false,"trashed":false,"lapsed":null,"subscribed":null,"forks":0,"collection":null,"type":"notebook","body":{"title":"GitHub API Helpers","cells":[{"id":0,"value":"md`# GitHub API Helpers\nThis notebook has some helpers for working with the [GitHub API](https://docs.github.com/en/rest/reference). For example, it’s used to get information about Workflows, like integration tests, in the [Flakiness](https://observablehq.com/@observablehq/integration-test-flakiness) and [Job Duration](https://observablehq.com/@observablehq/integration-test-duration) templates.\n\nTo authenticate, first fork this notebook. Create a GitHub [personal access token](https://github.com/settings/tokens) with no scopes selected, or the **repo** scope if you need access to a private repository. Save it in a [Secret](https://observablehq.com/settings/secrets) named \\`GITHUB_ACCESS_TOKEN\\` and refresh this page. Treat the Secret like a password! Do not share or publish a notebook with a Secret; if you do, the Secret will refuse to load.\n`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":419,"value":"apiKeyStatus = html`

\n API key:\n ${hasApiKey\n ? html`👍 Secret(\"GITHUB_ACCESS_TOKEN\") found.`\n : html`❌ Secret(\"GITHUB_ACCESS_TOKEN\") not found. Add it in Settings.`}\n

`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":74,"value":"rateLimitSummary = html`

\n Rate limit:\n ${rateLimit \n ? `${rateLimit.remaining} requests remaining; resets at ${rateLimit.reset.toLocaleTimeString(\"en-US\")}.` \n : \"No requests made yet.\"}\n

`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":212,"value":"md`Without authentication, you are rate-limited to 60 requests per hour; with a token, it goes up to 5,000 requests per hour. When you load this page it makes 7 requests: one to fetch workflows, one to fetch that workflows’s last 5 runs, and one for each of those 5 runs. So the total number of requests mostly depends on the \\`runLimit\\` passed to \\`fetchRuns\\`; it’s 5 here, but you’ll probably want it higher (we use 50).`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":308,"value":"md`Set the repo and workflow ID below; it defaults to the integration tests for the library [Svelte](https://github.com/sveltejs/svelte):`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":17,"value":"repo = \"sveltejs/svelte\"","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":101,"value":"workflow = 196961","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":233,"value":"md`Get the workflow ID from this table of the repo’s workflows:`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":103,"value":"workflows && md`\n \n \n ${workflows.map(({name, state, id}) => html`\n \n \n `)}\n \n

Workflow	ID
${name} (${state})	`${id}`

`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":171,"value":"md`Explore the results:`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":161,"value":"workflows = fetchWorkflows(repo)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":162,"value":"runs = fetchRuns(repo, workflow, {runsLimit: 5})","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":165,"value":"jobs = parseJobs(runs)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":366,"value":"md`To filter for jobs from a specific branch:`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":376,"value":"viewof branch = Inputs.select(new Set(runs.map(r => r.head_branch)))","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":378,"value":"jobs.filter(d => d.run.head_branch === branch)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":291,"value":"md`If you hit a rate limit or the API fails, you can use this cached version of the Svelte results for demonstration purposes:`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":320,"value":"sampleWorkflows = FileAttachment(\"workflows@1.json\").json()","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":324,"value":"sampleRuns = FileAttachment(\"runs.json\").json()","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":329,"value":"sampleJobs = parseJobs(sampleRuns)","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":144,"value":"md`---\n## Implementation`","pinned":false,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":12,"value":"hasApiKey = true","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":42,"value":"mutable rateLimit = null","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":501,"value":"GITHUB_ACCESS_TOKEN = \"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\"","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":488,"value":"// Makes an authenticated request if token is available, and updates the rate limit info\nfetchGithubResponse = async (path, params, options = {}) => {\n params = new URLSearchParams(params);\n const { headers, ...otherOptions } = options;\n const res = await fetch(`https://api.github.com${path}?${params}`, {\n headers: {\n ...(hasApiKey && { authorization: `token ${GITHUB_ACCESS_TOKEN}` }),\n accept: \"application/vnd.github.v3+json\",\n ...headers\n },\n ...otherOptions\n });\n mutable rateLimit = {\n remaining: +res.headers.get(\"X-RateLimit-Remaining\"),\n reset: new Date(res.headers.get(\"X-RateLimit-Reset\") * 1000)\n };\n return res;\n}","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":4,"value":"// Convenience function to skip right to the json response\nfetchGithub = async (...args) => {\n const res = await fetchGithubResponse(...args);\n return res.ok ? res.json() : false;\n}","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":20,"value":"fetchWorkflows = async (repo, {limit = 50} = {}) => \n (await fetchGithub(`/repos/${repo}/actions/workflows?per_page=${limit}`)).workflows","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":5,"value":"// This async generator progressively yields more jobs as they're fetched\nfetchRuns = async function* (\n repo,\n workflow,\n { runsLimit = hasApiKey ? 50 : 20, jobsLimit = 100 } = {}\n) {\n const runs = (\n await fetchGithub(`/repos/${repo}/actions/workflows/${workflow}/runs`, {\n per_page: runsLimit\n })\n ).workflow_runs;\n if (!runs) {\n return undefined;\n } else {\n for await (const [run, { jobs }] of runs.map(async (r) => [\n r,\n await fetchGithub(r.jobs_url.replace(\"https://api.github.com\", \"\"), {\n filter: \"all\",\n per_page: jobsLimit\n })\n ])) {\n run.jobs = jobs;\n yield runs;\n }\n }\n}","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"},{"id":10,"value":"// There are multiple jobs per run; this flattens them to return tidy data\nparseJobs = runs => {\n if(!runs) return undefined;\n const retries = [];\n return runs.flatMap(run => (run.jobs || []).map(j => {\n const name = j.name;\n const { run_number } = run;\n const retry = retries[[run_number, name]] = (retries[[run_number, name]] || 0) + 1;\n const started_at = new Date(j.started_at);\n const completed_at = new Date(j.completed_at);\n return {\n ...j,\n name,\n run,\n run_number: `${run_number}.${retry}`,\n message: run.head_commit.message,\n author: run.head_commit.author.name,\n branch: run.head_branch,// === 'main' ? 'main' : 'other',\n started_at,\n completed_at,\n minutes: (j.completed_at && j.started_at)\n ? (completed_at - started_at) / 1000 / 60\n : undefined\n }\n }))\n}","pinned":true,"hidden":false,"mode":"ojs","author":"$undefined","summary":"$undefined","output":"$undefined","database":"$undefined"}],"files":"$W33","stdlib":"1","titling":"auto"}} 32:"$31:body"