Te Whakatupuranga Deployments i roto i Deploy Hooks

A deploy hook is a secret URL that queues a new deployment when something sends it an HTTP POST. There is no authentication header: the secrecy of the URL is the authentication. Use hooks to let a…

Ko te pukamahi whakatūnga (deploy hook) he URL huna e whakaraupatu ana i tētahi whakatūnga hou i te mea ka tuku mai tēhia i tēhia te HTTP POST. Kāore he upoko whakamanatanga: ko te huna o te URL tēnei whakamanatanga. Whakamahia nga pukamahi kia taea ai e tēhia CMS koriti, tēhia mahi cron, tēhia arawhiti CI, me ēta atu rānei, kia hanga anō ai i tō kaupapa me te kore e taia te git.

Te Wāhi e Kimi Ai I Ngā Pukamahi Whakatūnga

Kei a rāua anō te tarawāhi ngā pukamahi: tuwhera i tō kaupapa i Orbit ka pīkau ki Hooks, kei /orbit/<project-id>/hooks.

Ka puta mai anō te pānui Deploy hooks tēnei i roto i te tarawāhi Settings o te kaupapa, ā, ka taea e koe te whawhai i a ia i tēia āki, i tēia āki rānei.

Deploy hooks panel in Orbit

Te Waihanga i tētahi Pukamahi Whakatūnga

Tuwhera i Orbit, kātahi ki tō kaupapa, kātahi ki Hooks.
Pīkau ki Add deploy hook.
Whakauru i tēhia Hook name e tino tonutanga te whakaaro i a ia i muri mai e ono pāpū. Ko te tohu ina te ahua: "Contentful publish", "Nightly cron".
Whiriwhiri i tēhia Target environment. E tūtuki ana ki te Production (default). Mēnā kei a koe tēhia taketake whakamātai, ka taea e koe te whakatika i te pukamahi ki te whakamātai engari.
Pīkau ki Create hook.

E puta mai ana te pukamahi i te rārangi me tōna URL, he pōtae Copy URL me he pōtae Delete hook.

Te URL o te Pukamahi

Kō ngā URL pukamahi e penei ana:

https://kpanel.kapsulehost.com/api/orbit/hooks/<token>

Ko te tohu he mea huna motuhake i waihangahia i te wā i hanga ai koe i te pukamahi.

Me tīkina te URL pukamahi kia rite ki tēhia kī API. Ko te tangata ē ā ai aua mea ka taea te whakatūnga o tō kaupapa, ā, ka kore a Orbit e whakatū i ō āki: ko te rakitanga whakatūnga, ko te whakaae e hiahia ana, ko te mahitahi CI e hiahia ana, me te angitu whakamātai e hiahia ana, e pā ana anake ki ngā whakatūnga e whakatuia ana e te taia, ā, ko te pukamahi e tika tonu ana. Kāore e pīkau i te URL pukamahi ki roto i tēhia tūrangawhare āpōpō, tēhia tuhinga tohutohu, tēhia āhua rānei, tēhia karapoti tautoko rānei.

Te Whakatuiui i tēhia Pukamahi

Tuku i tēhia pokapū POST. Kāore he tinana me kāore he upoko e hiahia ana.

curl -X POST \
  https://kpanel.kapsulehost.com/api/orbit/hooks/<your-token>

Ka whakahoki a Orbit ki te HTTP 202 me te ID whakatūnga. Ka puta mai te whakatūnga i te tarawāhi Deployments i roto i ētahi kēkēna.

Ko te pūrata ka whakaaetia anake te POST. Kāore te pokapū GET e whakatuiui i tēhia whakatūnga. Ko ētahi āwhina whakawhiti taumaha e tūtuki ana ki te GET, kāta koe e tirotiro i te tikanga mēnā ka kore tō pukamahi i te tangohanga e kuhu ana.

Te Mea e Whakatūia Ana e te Pukamahi

Ka whakaoti te pukamahi i tōna taketake pūmau (te āki i kuhu ai koe, tēnei rānei ko te taketake pūmau o te kaupapa), e pānui ana i te peka o tērā taketake, ā, me pokapū i tō kaiwhakahaere git mō te whakaemi o te peka tēnei. Ka whakaraupatu ai anō i tēhia whakatūnga o tērā whakaemi.

E toru ngā hua e tino tonutanga te mōhio:

E whakatūia ana anake e te pukamahi te peka puku. Kāore e taea e koe te kaupapa i tēhia SHA whakaemi tēnei te ingoa peka i te tinana pokapū; ka kaore i te tinana pokapū.
Me mahi pai te hononga kaiwhakahaere a te pukamahi. Mēnā kua tuwhera koe i GitHub, GitLab tēnei Bitbucket, kāore te pukamahi e āhei te pānui i te puka peke ā e kapo ana me te hapa, kāore hoki e whakatūia ana te tūranga pūroa.
E arongia ana e te pukamahi te hanga katoa. Kāore i te whakahoki, kāore i te tohu, engari he hanga hou anō o te mea e whakaohia ana i te peka.

Ngā Karanga Takitahi me Takitahi

E whakahaere ana a Orbit i ngā pukatapu karanga pukamahi i tēpū noa iho, kāore ka whakaraupatu i tēhia hanga mō ia kotahi.

Mēnā e haere ana te whakatūnga mō te whakaemi kotahi i tērā taketake, ka whakahoki te pukamahi i te whakatūnga kei a ia, ā, ka tohu i te whakahoki, i te kōpikitanga. Kāore he hanga tuarua e timata ana.
Mēnā e hanga ana mō tēhia whakaemi rerekē i tērā taketake, ka whakakahoa noa, ā, ka oti i tēhia hou, ā, kāore koe e utu mō tēhia hanga e tohu kē na roto.

Ko tēnei ka tūturu te pukamahi mō tēhia CMS e tuku nei i tēhia whakawhiti mō ia kuputaka i whakaputaina. Ko te whakaputanga o ngā whārangi e ono i roto i tēhia meneti ka hua i tēhia hanga, kāore ki te ono, ā, kāore e kapo i te ono haere mō te ono hanga.

Te Whakahononga i tēhia CMS Koriti

Ko te nuinga o ngā CMS koriti kei a ia te āhuatanga "whakawhiti i te whakaputanga". Ko te āhuatanga e tahi tonu: tohu i tō whakawhiti ki tō URL pukamahi Orbit, whakamahi POST, ā, waiho i ngā tautuhinga whakamanatanga kūare.

Contentful

Haere ki Settings, kātahi ki Webhooks, kātahi ki Add webhook.
Tautuhia te URL ki tō URL pukamahi Orbit.
Tautuhia te tikanga ki POST.
Tautuhia te whatinga ki Publish, tēnei rānei ko ēta atu āhuatanga ihirangi e tika ai kia hanga anō te pokapū.
Tiakina.

Sanity

I tō tūmanako kaupapa, haere ki API, kātahi ki Webhooks, kātahi ki Create webhook. Tautuhia te URL ki tō URL pukamahi, te tikanga ki POST, ā, whiriwhiri i te āhuatanga tuhinga me ngā āhuatanga whatinga.

Prismic

I te tūmanako, haere ki Settings, kātahi ki Webhooks, ā, tāpiri i tō URL pukamahi. Ka karangatia e Prismic i te wā o ia whakaputanga tuhinga.

Te Whakahononga i tēhia Mahi Cron tēnei Arawhiti CI

Ka taea e ētahi poukarero e whakatakoto i te pokapū HTTP:

# crontab: rebuild every night at 2am
0 2 * * * curl -fsS -X POST https://kpanel.kapsulehost.com/api/orbit/hooks/<your-token>

Mō CI, he āhuatanga ngāwari te pukamahi whakatūnga i te wā e hiahia ai koe i tō arawhiti kia whakatau mēnā ka kite i te whakatūnga. Ko te huatau tohutohu mō Bitbucket Pipelines, i te mea e whakatupu ana a Orbit i tōna kaupapa whakatūnga e hiahia ana i ngā ingoa mahi GitHub Actions tēnei ngā arawhiti GitLab, kāore i Bitbucket.

Mēnā e hiahia ana koe i ake atu i te "whakatūnga i te peka puku", whakamahi i tēhia tohu API engari i te pukamahi. Orbit, kātahi ki Tokens, e waihanga ana i ngā tohu kaihautu mō CI/CD me tēhia API REST whakamarama me tēhia āhuatanga GitHub Actions e ōkina ana. Ko te whakauru API e whakauru ana i te mahere Apex.

Te Hanga Anō i te Pokapū i te Pokapū Kore he Pukamahi

Mēnā ko te hiahia anake koe he hanga wāhanga, kāore koe e hiahia i tēhia pukamahi. Scheduled rebuild i Settings, i raro i Runtime, e hanga anō ai te pūmau ia haora, ia ono haora, ia 12 haora, ia rā, ia 2 rā tēnei ia wiki. E waihangahia ana mō tēhia āhuatanga tūrangawhare-CMS me te kore he URL huna kia whakaaro.

Te Tirotiro i te Āhuatanga o te Pukamahi

E whakaatu ana ia rārangi pukamahi he aha noa te whakatau i a ia, ā, i te wā i whakamahia ai, i te āhua "Used 14 times, last 3 Jul". Ko te whakatere kē ā te harikoa koe i tō CMS e karanga i te pukamahi i te wā i whakaaro ai koe.

Mēnā kāore e harikoa ake te tatau, ko te raru i te taha e karanga ana: tirotiro ko POST te tikanga, koia te URL, ā, kāore e hōhā noa i tēhia hapa TLS tēnei whakatupuranga.

Te Whakamate i tēhia Pukamahi

Pīkau ki Delete hook i te rārangi ā whakaaetia. Ko te kōrero ka tohu ā ko ētahi āhuatanga e whakamahi ana ka mutu, ā, koia tonu te mea ka puta.

Kāore he āhuatanga kia pouaka te tohu pukamahi i te waenganui. Mēnā ka whakaputa tēhia URL, ka whakamate koe i te pukamahi ā ka waihanga i tēhia hou, kātahi ka whakahou i ia pūnaha i whakamahia ai te URL tawhito. Ka mahi tonu te whakamatenga, kāta ka whakapaetai i te whakawhiti i mua tonu i te whakamate engari i muri.

Te Whakatika i te Raru

Kāore e puta mai ana te mea i te karanga i te pukamahi. Tirotiro ko POST te tikanga. Tirotiro te URL wetā mō te wetā, tae atu ki te tohu. Tirotiro te tatau whakatau pukamahi i te tarawāhi Hooks: mēnā kāore e harikoa, kāore te pokapū i tae mai.

E whakahoki ana te pukamahi i tēhia hapa e pā ana ki te whakaemi o nāianei. Kāore a Orbit i āhei te pānui i te peka puke mai i tō kaiwhakahaere git. Whakahonohia anō te kaiwhakahaere mai i Orbit, kātahi New project, kātahi Reconnect, ā whakaaetia te tūrangawhare e tonu ana.

E whakahoki ana te pukamahi i tēhia hapa e pā ana ki te taketake pūmau. Kāore te taketake pūmau i te pukamahi i whakahia ai e noho ana, ko te nuinga o te wā nō te mea ka whakamatehia tēhia taketake whakamātai. Whakamatehia te pukamahi ā waihanga i tēhia hou i tēhia taketake e ora ana.

E ara mai ana te pukamahi engari ko te whakatūnga he rite tonu i mua. Ko tēnei te āhuatanga kōpikitanga: kāore te peka puke i te huri, kāta kāore he mea hou hei hanga. Taia tēhia whakaemi, tēnei rānei whakamahi Deploy now mēnā e hiahia ana koe kia hanga anō i te whakaemi kotahi.

Te Pānuitanga E Hāngai Ana

Deploying Your Project mō ngā āki whakatūnga me ēta atu e kapo ana ngā pukamahi
Connecting a Bitbucket Repo mō te āhuatanga whakatūnga CI e whakaoti ai ngā pukamahi
Environment Variables, i te mea ka pānui anō i tēhia whirihora e whakatūia ana e te pukamahi i ērā atu