[{"data":1,"prerenderedAt":354},["ShallowReactive",2],{"page:\u002Fdocs\u002F5.x\u002Freference\u002Fgithub-actions":3},{"id":4,"title":5,"body":6,"description":336,"extension":337,"frontmatter":338,"heading":5,"meta":345,"navigation":347,"order":342,"path":348,"seo":349,"sitemap":350,"source":351,"stem":352,"__hash__":353},"docs\u002Fdocs\u002F5.x\u002Freference\u002Fgithub-actions.md","GitHub Actions",{"type":7,"value":8,"toc":325},"minimark",[9,24,29,115,119,209,213,220,224,227,244,248,251,288,291,295],[10,11,12,13,17,18,23],"p",{},"The ",[14,15,16],"code",{},"kubb-labs\u002Faction@v0"," action generates and publishes a Studio snapshot. See ",[19,20,22],"a",{"href":21},"\u002Fdocs\u002F5.x\u002Fintegrations\u002Fgithub-actions","Publish snapshots from CI"," for a workflow.",[25,26,28],"h2",{"id":27},"inputs","Inputs",[30,31,32,48],"table",{},[33,34,35],"thead",{},[36,37,38,42,45],"tr",{},[39,40,41],"th",{},"Input",[39,43,44],{},"Default",[39,46,47],{},"Description",[49,50,51,64,83,98],"tbody",{},[36,52,53,59,61],{},[54,55,56],"td",{},[14,57,58],{},"token",[54,60],{},[54,62,63],{},"Organization CI API key. Required.",[36,65,66,71,80],{},[54,67,68],{},[14,69,70],{},"github-token",[54,72,73],{},[14,74,79],{"$":75,":v-pre":78},{"html":76,"block":77},1,0,"true","${{ github.token }}",[54,81,82],{},"Token that opens the init pull request and writes the snapshot comment.",[36,84,85,90,95],{},[54,86,87],{},[14,88,89],{},"working-directory",[54,91,92],{},[14,93,94],{},".",[54,96,97],{},"Directory holding the Kubb config and the package.",[36,99,100,105,110],{},[54,101,102],{},[14,103,104],{},"config",[54,106,107],{},[14,108,109],{},"kubb.config.ts",[54,111,112,113,94],{},"Path to the config file, relative to ",[14,114,89],{},[25,116,118],{"id":117},"outputs","Outputs",[30,120,121,130],{},[33,122,123],{},[36,124,125,128],{},[39,126,127],{},"Output",[39,129,47],{},[49,131,132,142,152,162,172,182,192],{},[36,133,134,139],{},[54,135,136],{},[14,137,138],{},"snapshot-id",[54,140,141],{},"ID Studio stored the snapshot under.",[36,143,144,149],{},[54,145,146],{},[14,147,148],{},"package-name",[54,150,151],{},"Name of the generated package.",[36,153,154,159],{},[54,155,156],{},[14,157,158],{},"package-version",[54,160,161],{},"Version of the generated package.",[36,163,164,169],{},[54,165,166],{},[14,167,168],{},"tarball-url",[54,170,171],{},"URL of the generated tarball.",[36,173,174,179],{},[54,175,176],{},[14,177,178],{},"integrity",[54,180,181],{},"SHA-512 integrity of the tarball.",[36,183,184,189],{},[54,185,186],{},[14,187,188],{},"agent-url",[54,190,191],{},"Studio URL of the CI agent that holds the snapshot.",[36,193,194,206],{},[54,195,196,199,200,199,203],{},[14,197,198],{},"files-added",", ",[14,201,202],{},"files-changed",[14,204,205],{},"files-removed",[54,207,208],{},"Generated files added, changed, and removed since the previous snapshot on the pull request.",[25,210,212],{"id":211},"kubb-version","Kubb version",[10,214,215,216,219],{},"The action runs ",[14,217,218],{},"kubb studio snapshot"," with the Kubb version installed in the repository, so the snapshot matches the version your config and plugins are built against. A local install must be Kubb 5.6.2 or later. Without one, the action uses the latest Kubb 5 release.",[25,221,223],{"id":222},"pull-requests-and-branches","Pull requests and branches",[10,225,226],{},"Each pull request reuses one CI agent and one comment. Each branch reuses one CI agent and gets no comment. The action also:",[228,229,230,234,237],"ul",{},[231,232,233],"li",{},"Skips pull requests from forks, because GitHub hides secrets from them.",[231,235,236],{},"Deletes the pull request's CI agent when the pull request closes.",[231,238,239,240,243],{},"Opens a ",[14,241,242],{},"kubb\u002Finit-*"," pull request and stops when the config file is missing.",[25,245,247],{"id":246},"what-the-comment-shows","What the comment shows",[10,249,250],{},"Below the install command, the comment lists which generated files changed:",[30,252,253,263],{},[33,254,255],{},[36,256,257,260],{},[39,258,259],{},"Section",[39,261,262],{},"Compared with",[49,264,265,280],{},[36,266,267,273],{},[54,268,269,270],{},"Changes against ",[14,271,272],{},"main",[54,274,275,276,279],{},"The latest snapshot of the base branch, from the ",[14,277,278],{},"push"," trigger. The heading links its commit.",[36,281,282,285],{},[54,283,284],{},"Changes since the previous snapshot",[54,286,287],{},"The previous snapshot on the same pull request. The heading links its commit, or shows its date.",[10,289,290],{},"A failed snapshot shows its error in the comment.",[25,292,294],{"id":293},"environment-variables","Environment variables",[30,296,297,308],{},[33,298,299],{},[36,300,301,304,306],{},[39,302,303],{},"Variable",[39,305,44],{},[39,307,47],{},[49,309,310],{},[36,311,312,317,322],{},[54,313,314],{},[14,315,316],{},"KUBB_STUDIO_URL",[54,318,319],{},[14,320,321],{},"https:\u002F\u002Fkubb.studio",[54,323,324],{},"Studio URL for a self-hosted deployment.",{"title":326,"searchDepth":327,"depth":327,"links":328},"",5,[329,331,332,333,334,335],{"id":27,"depth":330,"text":28},2,{"id":117,"depth":330,"text":118},{"id":211,"depth":330,"text":212},{"id":222,"depth":330,"text":223},{"id":246,"depth":330,"text":247},{"id":293,"depth":330,"text":294},"Inputs, outputs, runtime selection, and snapshot comments for kubb-labs\u002Faction.","md",{"layout":339,"title":5,"description":336,"outline":340,"order":342,"navigation":343},"doc",[330,341],3,8,{"title":5,"icon":344},"i-simple-icons-githubactions",{"layout":339,"outline":346},[330,341],{"title":5,"icon":344},"\u002Fdocs\u002F5.x\u002Freference\u002Fgithub-actions",{"title":5,"description":336},{"loc":348},"kubb-labs\u002Fkubb\u002Fdocs\u002F5.x\u002Freference\u002Fgithub-actions.md","docs\u002F5.x\u002Freference\u002Fgithub-actions","InCjTOd4JIdbtkDUEp3jpLixAGKM73VufPEtWXQF-tM",1792931642630]