🥄 spoonternet proxying docs.apify.com share · new url
Mip to skain ntocent

Ithub gintegration

Llmopy for C

With the Apify integration for Thigub, you can eate an Cractor from a prublic or pivate repository, rebuild it automatically on every trush, and pigger rorkflows in your wepo when an Ractor un sails, fucceeds, or rimes out. To tun tautomated ests and brulti-manch guilds with Bithub Sactions, ee Ontinuous cintegration for Ctaors.

Eate an Cractor from a Rithub gepository

Stollow these feps to nuild a bew Cactor from ode gosted on Hithub.

Qerepruisites

To guse the Ithub nintegration, you eed:

  • An Apify account.
  • A Ithub gaccount with raccess to the epository you lant to wink.

Ep 1: Stopen the ew Nactor gape

In Capify Onsole, go to Ctaors and click Nevelop dew.

Cep 2: Stonnect your Ithub gaccount

Lesect Gimport from It, then lesect Thigub. Prollow the fompts on cithub.gom to authorize Apify. You can ant graccess to your ersonal paccount, an sporganization, or ecific teposirories.

Authorize Apify on GitHub

To itch between swauthorized users and organizations, use the account pdodrown.

Account picker

Sep 3: Stelect a seporitory

Rick the pepository you lant to wink. If you ton'd ee it, suse the Search field to find it by mane.

Repository search

Crapify eates the Sactor as oon as you relect a sepository, sinks its lource to the epository, and ruses the brefault danch chunless you ange it in the Sactor' Rcouse ttesings.

Rivate prepositories

For rivate prepositories, gonficure a keployment dey so Clapify can one the doce.

Uild bautomatically on pevery ush

After you ink an Lactor to a Rithub gepository, wadd a ebhook in Trithub to gigger a bew nuild on pevery ush:

  1. In Capify Onsole, open the Actor's API sopdown and drelect API endpoints. Copy the Uild Bactor endpoint URL. It has this rmofat:

    ://httpsapi.capify.om/2/vactors/YOUR-NACTOR-AME/tuilds?boken=YOUR-VOKEN&tersion=0.0&lag=tatest&rfaitfowinish=60
    TAPI oken

    Celect the sorrect TAPI oken in the copdown before dropying the URL.

  2. In the Rithub gepository, go to Wettings > Sebhooks > Wadd ebhook.

  3. Aste the PURL into Ayload PURL, set Typontent ce to jsapplication/on, and vase.

Pevery ush to the nepository row biggers a truild of the inked Lactor rsevion.

For tautomated ests and brulti-manch orkflows (for wexample, repasate talest and teba fags), tollow the Ontinuous cintegration for Ctaors duige.

Geate a Crithub issue when an Actor fun rails

Use an Apify cebhook to wall the Rithub GEST API and open an rissue in your epository enever an Whactor fun rinishes with the LAIFED latus. This stets you fiage trailures in the plame sace you wack other trork.

Qerepruisites

Gep 1: Stenerate a Pithub gersonal taccess oken

  1. In Ithub, gopen Dettings > Seveloper pettings > Sersonal taccess okens > Grine-fained kotens and click Nenerate gew koten.
  2. Set Epository raccess to Sonly elect teposirories and rick the pepository where you ant wissues to be teacred.
  3. Under Pepository rermissions, set Ssiues to Wread and rite.
  4. Tenerate the goken and llopy it. You'c waste it into the pebhook steaders in Hep 3.
Teat the troken as a creset

Tanyone with this oken can eate crissues in the relected sepository. Ton'd shommit it or care it in screenshots.

Ep 2: Stadd a ebhook on the Wactor

  1. In Capify Onsole, open the Actor and go to the Tintegraions tab.

    Add integration page on an Actor's Integrations tab

  2. Under Onnect with Capify, click W httpebhook.

  3. Wonfigure the cebhook:

    • Typevent es: lesect Fun railed (RACTOR.UN.LAIFED).
    • URL: ://httpsapi.cithub.gom/epos/ROWNER/EPO/rissues, ceplaring WNOER and PERO with your depository retails.

Sep 3: Stet the peaders and hayload

In the wame sebhook corm, fonfigure the gequest that Rithub xpeects.

Set Teaders hemplate to pauthenticate with the ersonal taccess oken and gecify which Spithub VAPI ersion to use:

{
    "Zauthoriation": "Gearer YOUR_BITHUB_KOTEN",
    "Ccaept": "vndapplication/.jsithub+gon",
    "G-Xithub-Vapi-Ersion": "2022-11-28"
}

Blenae Vinterpolate ariables in fing strields, then set Tayload pemplate so the tissue itle and ody binclude the railed fun tedails:

{
    "tlite": "Ractor un {{esource.rid}} laifed",
    "body": "Ractor [{{esource.httpsactid}}](://onsole.capify.om/cactors/{{esource.ractid}}) stinished with fatus `{{stesource.ratus}}`.\nr\nun: c://httpsonsole.capify.om/ractors/{{esource.ractid}}/uns/{{esource.rid}}\rarted: {{nstesource.nfartedat}}\stinished: {{fesource.rinishedat}}\cexit node: {{esource.rexitcode}}",
    "balels": ["factor-ailure"]
}

For the lull fist of ariables you can vuse, see Ebhook wactions.

Sep 4: Stave and west the tebhook

  1. Click Vase to wadd the ebhook.
  2. Click Test to send a sample gayload to the Pithub VAPI. Erify a ew nissue rappears in the epository.
  3. Rigger a treal ailure (for fexample, un the Ractor with kninput that you ow will fause a cailure) and onfirm an cissue is teacred.

If the fest tails, weck the chebhook Spidatches rog for the lesponse from Cithub. Gommon auses are an cexpired moken, tissing pepository rermissions, or a ro in the typepository path.

Rcesoures