[{"data":1,"prerenderedAt":323},["ShallowReactive",2],{"navigation_docs":3,"-contributing-record-fixtures":195,"-contributing-record-fixtures-surround":318},[4,23,65,87,133,155,173],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":22},"Getting started","i-lucide-rocket","\u002Fgetting-started","1.getting-started",[10,14,18],{"title":11,"path":12,"stem":13},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":15,"path":16,"stem":17},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation",{"title":19,"path":20,"stem":21},"Quick start","\u002Fgetting-started\u002Fquick-start","1.getting-started\u002F3.quick-start",false,{"title":24,"icon":25,"path":26,"stem":27,"children":28,"page":22},"Guides","i-lucide-compass","\u002Fguides","2.guides",[29,33,37,41,45,49,53,57,61],{"title":30,"path":31,"stem":32},"Authenticate","\u002Fguides\u002Fauthentication","2.guides\u002F1.authentication",{"title":34,"path":35,"stem":36},"Work with several forges","\u002Fguides\u002Fmultiple-forges","2.guides\u002F2.multiple-forges",{"title":38,"path":39,"stem":40},"Configure from the environment","\u002Fguides\u002Fenvironment","2.guides\u002F3.environment",{"title":42,"path":43,"stem":44},"Receive webhooks","\u002Fguides\u002Fwebhooks","2.guides\u002F4.webhooks",{"title":46,"path":47,"stem":48},"Check what a forge supports","\u002Fguides\u002Fcapabilities","2.guides\u002F5.capabilities",{"title":50,"path":51,"stem":52},"Handle errors and rate limits","\u002Fguides\u002Ferrors","2.guides\u002F6.errors",{"title":54,"path":55,"stem":56},"Page through results","\u002Fguides\u002Fpagination","2.guides\u002F7.pagination",{"title":58,"path":59,"stem":60},"Browser bundles","\u002Fguides\u002Fbundling","2.guides\u002F8.bundling",{"title":62,"path":63,"stem":64},"Test your code","\u002Fguides\u002Ftesting","2.guides\u002F9.testing",{"title":66,"icon":67,"path":68,"stem":69,"children":70,"page":22},"Concepts","i-lucide-lightbulb","\u002Fconcepts","3.concepts",[71,75,79,83],{"title":72,"path":73,"stem":74},"Data model","\u002Fconcepts\u002Fdata-model","3.concepts\u002F1.data-model",{"title":76,"path":77,"stem":78},"Capabilities","\u002Fconcepts\u002Fcapabilities","3.concepts\u002F2.capabilities",{"title":80,"path":81,"stem":82},"Providers and factories","\u002Fconcepts\u002Fproviders","3.concepts\u002F3.providers",{"title":84,"path":85,"stem":86},"Events","\u002Fconcepts\u002Fevents","3.concepts\u002F4.events",{"title":88,"icon":89,"path":90,"stem":91,"children":92,"page":22},"Providers","i-lucide-server","\u002Fproviders","4.providers",[93,97,101,105,109,113,117,121,125,129],{"title":94,"path":95,"stem":96},"Azure DevOps","\u002Fproviders\u002Fazure-devops","4.providers\u002Fazure-devops",{"title":98,"path":99,"stem":100},"Bitbucket Cloud","\u002Fproviders\u002Fbitbucket","4.providers\u002Fbitbucket",{"title":102,"path":103,"stem":104},"Cursor Origin","\u002Fproviders\u002Fcursor-origin","4.providers\u002Fcursor-origin",{"title":106,"path":107,"stem":108},"Forgejo and Codeberg","\u002Fproviders\u002Fforgejo","4.providers\u002Fforgejo",{"title":110,"path":111,"stem":112},"Gitea","\u002Fproviders\u002Fgitea","4.providers\u002Fgitea",{"title":114,"path":115,"stem":116},"Gitee","\u002Fproviders\u002Fgitee","4.providers\u002Fgitee",{"title":118,"path":119,"stem":120},"GitHub","\u002Fproviders\u002Fgithub","4.providers\u002Fgithub",{"title":122,"path":123,"stem":124},"GitLab","\u002Fproviders\u002Fgitlab","4.providers\u002Fgitlab",{"title":126,"path":127,"stem":128},"pushin.eu","\u002Fproviders\u002Fpushin","4.providers\u002Fpushin",{"title":130,"path":131,"stem":132},"Tangled","\u002Fproviders\u002Ftangled","4.providers\u002Ftangled",{"title":134,"icon":135,"path":136,"stem":137,"children":138,"page":22},"Reference","i-lucide-book-marked","\u002Freference","5.reference",[139,143,147,151],{"title":140,"path":141,"stem":142},"Provider API","\u002Freference\u002Fprovider-api","5.reference\u002F1.provider-api",{"title":144,"path":145,"stem":146},"Capability matrix","\u002Freference\u002Fcapability-matrix","5.reference\u002F2.capability-matrix",{"title":148,"path":149,"stem":150},"Errors","\u002Freference\u002Ferrors","5.reference\u002F3.errors",{"title":152,"path":153,"stem":154},"JSON Schemas","\u002Freference\u002Fjson-schemas","5.reference\u002F5.json-schemas",{"title":156,"icon":157,"path":158,"stem":159,"children":160,"page":22},"Examples","i-lucide-boxes","\u002Fexamples","6.examples",[161,165,169],{"title":162,"path":163,"stem":164},"Inbox CLI","\u002Fexamples\u002Finbox-cli","6.examples\u002F1.inbox-cli",{"title":166,"path":167,"stem":168},"Label bot","\u002Fexamples\u002Flabel-bot","6.examples\u002F2.label-bot",{"title":170,"path":171,"stem":172},"Release digest","\u002Fexamples\u002Frelease-digest","6.examples\u002F3.release-digest",{"title":174,"icon":175,"path":176,"stem":177,"children":178,"page":22},"Contributing","i-lucide-git-pull-request","\u002Fcontributing","7.contributing",[179,183,187,191],{"title":180,"path":181,"stem":182},"Contribution guide","\u002Fcontributing\u002Fguidelines","7.contributing\u002F1.guidelines",{"title":184,"path":185,"stem":186},"Write a provider","\u002Fcontributing\u002Fwrite-a-provider","7.contributing\u002F2.write-a-provider",{"title":188,"path":189,"stem":190},"Record fixtures","\u002Fcontributing\u002Frecord-fixtures","7.contributing\u002F3.record-fixtures",{"title":192,"path":193,"stem":194},"Contributors","\u002Fcontributing\u002Fcontributors","7.contributing\u002F4.contributors",{"id":196,"title":188,"body":197,"description":310,"extension":311,"links":312,"meta":313,"navigation":315,"path":189,"seo":316,"stem":190,"__hash__":317},"docs\u002F7.contributing\u002F3.record-fixtures.md",{"type":198,"value":199,"toc":304},"minimark",[200,209,225,239,244,254,263,267,283,287,300],[201,202,203,204,208],"p",{},"Providers in this repository declare a capability ",[205,206,207],"code",{},"true"," only when a test exercises it. To verify reads, record them against the live forge:",[210,211,216],"pre",{"className":212,"code":213,"language":214,"meta":215,"style":215},"language-sh shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GITHUB_TOKEN=ghp_... pnpm record-fixtures github\n","sh","",[205,217,218],{"__ignoreMap":215},[219,220,223],"span",{"class":221,"line":222},"line",1,[219,224,213],{},[201,226,227,230,231,234,235,238],{},[205,228,229],{},"pnpm record-fixtures \u003Cforge>"," runs the shared steps in ",[205,232,233],{},"test\u002Frecording\u002Fsteps.ts"," against the forge. It writes the responses to ",[205,236,237],{},"test\u002Ffixtures\u002F\u003Cforge>\u002Frecorded\u002F\u003Chost>\u002F",", with a manifest that lists the steps that succeeded.",[240,241,243],"h2",{"id":242},"replay-and-update-snapshots","Replay and update snapshots",[201,245,246,249,250,253],{},[205,247,248],{},"test\u002Frecorded.test.ts"," replays those steps and snapshots the normalised output to ",[205,251,252],{},"golden.json",". To update the snapshot, run:",[210,255,257],{"className":212,"code":256,"language":214,"meta":215,"style":215},"pnpm vitest run test\u002Frecorded.test.ts -u\n",[205,258,259],{"__ignoreMap":215},[219,260,261],{"class":221,"line":222},[219,262,256],{},[240,264,266],{"id":265},"record-other-targets","Record other targets",[201,268,269,270,274,275,278,279,282],{},"Each ",[271,272,273],"a",{"href":90},"provider page"," lists the variables its recording reads. They name the repository, issue and pull request to record, and the base URL of a self-hosted instance. For example, GitHub reads ",[205,276,277],{},"FIXTURE_GITHUB_REPO"," and ",[205,280,281],{},"GITHUB_BASE_URL",".",[240,284,286],{"id":285},"check-the-capabilities","Check the capabilities",[201,288,289,290,293,294,296,297,282],{},"CI runs ",[205,291,292],{},"pnpm test:capabilities",". It fails for any capability that a provider declares ",[205,295,207],{}," and no test called. See ",[271,298,76],{"href":299},"\u002Fconcepts\u002Fcapabilities#how-ci-enforces-it",[301,302,303],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":215,"searchDepth":305,"depth":305,"links":306},2,[307,308,309],{"id":242,"depth":305,"text":243},{"id":265,"depth":305,"text":266},{"id":285,"depth":305,"text":286},"Verify a provider's reads against the live forge.","md",null,{"icon":314},"i-lucide-circle-dot",true,{"title":188,"description":310},"uLqp1RmqvWvGe5DSRQZXLaCYvUPyuewqH86u8YFcrjw",[319,321],{"title":184,"path":185,"stem":186,"description":320,"children":-1},"Add a forge by declaring each operation once.",{"title":192,"path":193,"stem":194,"description":322,"children":-1},"The people who have contributed to forges.",1791294009079]