[{"data":1,"prerenderedAt":537},["ShallowReactive",2],{"navigation_docs":3,"-contributing-write-a-provider":195,"-contributing-write-a-provider-surround":532},[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":184,"body":197,"description":524,"extension":525,"links":526,"meta":527,"navigation":529,"path":185,"seo":530,"stem":186,"__hash__":531},"docs\u002F7.contributing\u002F2.write-a-provider.md",{"type":198,"value":199,"toc":518},"minimark",[200,217,228,372,402,407,430,440,444,453,457,471,475,486,493,504,514],[201,202,203,204,208,209,212,213,216],"p",{},"A provider is one call to ",[205,206,207],"code",{},"defineForgeProvider()",". You declare each operation once, with ",[205,210,211],{},"verb(support, run)",", or with ",[205,214,215],{},"perKind(kinds, run)"," when support depends on the thread kind. Each declaration produces both the method and its capability entry.",[201,218,219,220,223,224,227],{},"In this excerpt from a provider's ",[205,221,222],{},"setup()",", issue reads are experimental and ",[205,225,226],{},"getMany"," is unsupported:",[229,230,235],"pre",{"className":231,"code":232,"language":233,"meta":234,"style":234},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const threads = {\n  get: perKind({ issue: 'experimental' }, getIssue),\n  listPage: perKind({ issue: 'experimental' }, listIssues),\n  getMany: verb(false, async () => []),\n}\n","ts","",[205,236,237,257,301,332,366],{"__ignoreMap":234},[238,239,242,246,250,254],"span",{"class":240,"line":241},"line",1,[238,243,245],{"class":244},"spNyl","const",[238,247,249],{"class":248},"sTEyZ"," threads ",[238,251,253],{"class":252},"sMK4o","=",[238,255,256],{"class":252}," {\n",[238,258,260,264,267,271,274,277,280,282,285,289,292,295,298],{"class":240,"line":259},2,[238,261,263],{"class":262},"swJcz","  get",[238,265,266],{"class":252},":",[238,268,270],{"class":269},"s2Zo4"," perKind",[238,272,273],{"class":248},"(",[238,275,276],{"class":252},"{",[238,278,279],{"class":262}," issue",[238,281,266],{"class":252},[238,283,284],{"class":252}," '",[238,286,288],{"class":287},"sfazB","experimental",[238,290,291],{"class":252},"'",[238,293,294],{"class":252}," },",[238,296,297],{"class":248}," getIssue)",[238,299,300],{"class":252},",\n",[238,302,304,307,309,311,313,315,317,319,321,323,325,327,330],{"class":240,"line":303},3,[238,305,306],{"class":262},"  listPage",[238,308,266],{"class":252},[238,310,270],{"class":269},[238,312,273],{"class":248},[238,314,276],{"class":252},[238,316,279],{"class":262},[238,318,266],{"class":252},[238,320,284],{"class":252},[238,322,288],{"class":287},[238,324,291],{"class":252},[238,326,294],{"class":252},[238,328,329],{"class":248}," listIssues)",[238,331,300],{"class":252},[238,333,335,338,340,343,345,349,352,355,358,361,364],{"class":240,"line":334},4,[238,336,337],{"class":262},"  getMany",[238,339,266],{"class":252},[238,341,342],{"class":269}," verb",[238,344,273],{"class":248},[238,346,348],{"class":347},"sfNiH","false",[238,350,351],{"class":252},",",[238,353,354],{"class":244}," async",[238,356,357],{"class":252}," ()",[238,359,360],{"class":244}," =>",[238,362,363],{"class":248}," [])",[238,365,300],{"class":252},[238,367,369],{"class":240,"line":368},5,[238,370,371],{"class":252},"}\n",[201,373,374,377,378,381,382,385,386,389,390,393,394,397,398,401],{},[205,375,376],{},"forges"," adds the rest of the provider: ",[205,379,380],{},"capabilities",", ",[205,383,384],{},"can()",", the iterables (",[205,387,388],{},"list"," from ",[205,391,392],{},"listPage",", for example), ",[205,395,396],{},"readOnly",", anonymous handling and a ",[205,399,400],{},"webhooks.ingest()"," that verifies each delivery before it translates it.",[403,404,406],"h2",{"id":405},"declare-operations","Declare operations",[201,408,409,412,413,422,423,426,427,429],{},[205,410,411],{},"ProviderSpec"," in ",[414,415,419],"a",{"href":416,"rel":417},"https:\u002F\u002Fgithub.com\u002Fdanielroe\u002Fforges\u002Fblob\u002Fmain\u002Fsrc\u002Fdefine.ts",[418],"nofollow",[205,420,421],{},"src\u002Fdefine.ts"," lists every operation and marks which ones are required. Declare a required operation that your forge lacks with ",[205,424,425],{},"verb(false, ...)",". Any other operation that you leave out, and any thread kind that you don't list, is ",[205,428,348],{},".",[201,431,432,439],{},[414,433,436],{"href":434,"rel":435},"https:\u002F\u002Fgithub.com\u002Fdanielroe\u002Fforges\u002Fblob\u002Fmain\u002Fsrc\u002Fpushin\u002Findex.ts",[418],[205,437,438],{},"src\u002Fpushin\u002Findex.ts"," is a short provider to read as an example.",[403,441,443],{"id":442},"handle-webhooks","Handle webhooks",[201,445,446,447,450,451,429],{},"Webhook handlers go in the ",[205,448,449],{},"webhooks"," field of the definition. For a Lite variant, define a second factory from the same definition without ",[205,452,449],{},[403,454,456],{"id":455},"send-requests","Send requests",[201,458,459,460,463,464,467,468,470],{},"Use ",[205,461,462],{},"ctx.fetcher"," for requests. It applies the base URL, auth header, user agent, timeout and the caller's ",[205,465,466],{},"fetch",", and it maps rate limits and revoked tokens to ",[205,469,376],{}," errors.",[403,472,474],{"id":473},"run-scripts-without-a-build","Run scripts without a build",[201,476,477,478,481,482,485],{},"Source files import each other with ",[205,479,480],{},".ts"," extensions, so ",[205,483,484],{},"node scripts\u002F\u003Cname>.ts"," runs without a build.",[201,487,488,489,492],{},"After you change a provider's capabilities, regenerate the ",[414,490,491],{"href":145},"capability matrix"," and the table on each provider page:",[229,494,498],{"className":495,"code":496,"language":497,"meta":234,"style":234},"language-sh shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm capability-matrix\n","sh",[205,499,500],{"__ignoreMap":234},[238,501,502],{"class":240,"line":241},[238,503,496],{},[201,505,506,507,510,511,429],{},"Then ",[414,508,509],{"href":189},"record fixtures"," so that capabilities can be ",[205,512,513],{},"true",[515,516,517],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}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":234,"searchDepth":259,"depth":259,"links":519},[520,521,522,523],{"id":405,"depth":259,"text":406},{"id":442,"depth":259,"text":443},{"id":455,"depth":259,"text":456},{"id":473,"depth":259,"text":474},"Add a forge by declaring each operation once.","md",null,{"icon":528},"i-lucide-hammer",true,{"title":184,"description":524},"cvaQ-8QTrMPbbVSEMRX2b9_GalNVOCinGIgIddiJUro",[533,535],{"title":180,"path":181,"stem":182,"description":534,"children":-1},"Set up the repository, run the checks and follow the rules that keep providers consistent.",{"title":188,"path":189,"stem":190,"description":536,"children":-1},"Verify a provider's reads against the live forge.",1791294008955]