INTEGRITY Dokumentace

Konfigurace

Při propojování repozitáře Git s vaším Workerem můžete přizpůsobit konfiguraci potřebnou k sestavení a nasazení Workeru.

Jak funguje Workers Builds

Když je commit odeslán do vašeho propojeného repozitáře, Workers Builds spustí dvoukrokový proces:

  1. Příkaz sestavení (optional) : zkompiluje váš projekt (například npm run build pro frameworky jako Next.js nebo Astro)
  2. Příkaz pro nasazení - Nasadí váš Worker do Cloudflare (výchozí je npx wrangler deploy)

U náhledových sestavení (commitů do jiných větví, než je vaše produkční větev) se příkaz deploy nahrazuje příkaz pro nasazení náhledu (výchozí hodnota je npx wrangler versions upload), což vytvoří náhledovou verzi bez jejího povýšení do produkce.

Nastavení sestavení

Nastavení sestavení najdete v části Nastavení > Sestavit v rámci vašeho Workeru.

Mějte na paměti, že po aktualizaci a uložení nastavení sestavení se tato aktualizovaná nastavení použijí na vaše další build. Když opakovat sestavení, použijí se konfigurace sestavení, které existují v okamžiku opakování sestavení.

Přehled

Nastavení Popis
Účet Git Vyberte účet Git, který chcete použít. Po prvním připojení můžete tento účet Git používat i pro další projekty.
Git repozitář Zvolte repozitář Git, který chcete připojit ke svému Workeru.
Větev Git Vyberte větev, kterou má Cloudflare sledovat kvůli novým commitům. Výchozí hodnotou bude main.
Příkaz sestavení (Volitelné) Nastavte příkaz sestavení, pokud váš projekt vyžaduje krok sestavení (např. npm run build). To je nutné například při použití frontendový framework jako například Next.js nebo Remix.
Příkaz pro nasazení Příkaz deploy vám umožňuje nastavit konkrétní příkaz Wrangler použitý k nasazení vašeho Workeru. Váš příkaz pro nasazení bude ve výchozím stavu npx wrangler deploy ale tento příkaz můžete přizpůsobit. Workers Builds použije verzi Wrangleru nastavenou ve vašem package.json.
Příkaz pro nasazení neprodukční větve Nastavte příkaz, který se má spustit při provádění sestavení pro commit v neprodukční větvi. Výchozí hodnota bude npx wrangler versions upload ale tento příkaz můžete přizpůsobit. Workers Builds použije verzi Wrangleru nastavenou ve vašem package.json.
Kořenový adresář (Volitelné) Zadejte cestu k projektu. Kořenový adresář určuje, kde se spustí sestavovací příkaz, a může se hodit v monorepa k izolaci konkrétního projektu v rámci repozitáře pro sestavování.
API token (Volitelné) Token API se používá k ověření vašeho požadavku na sestavení a k autorizaci nahrání a nasazení Workeru do Cloudflare. Cloudflare ve výchozím nastavení automaticky vygeneruje token API pro váš účet při použití Workers Builds a tento token API pak používá pro všechna další sestavení. Případně můžete vytvořte si vlastní API token, nebo vyberte takovou, kterou už vlastníte.
Proměnné a tajné klíče sestavení (Volitelné) Přidejte proměnné prostředí a tajné klíče dostupné pouze pro sestavení. Proměnné sestavení nebudou dostupné za běhu. Pokud chcete nakonfigurovat proměnné za běhu, můžete to udělat v Nastavení > Proměnné a tajné klíče

Příkaz pro nasazení

Příkaz pro nasazení můžete spustit pomocí správce balíčků dle vlastního výběru.

Pokud jste přidali příkaz Wrangler deploy jako skript v package.json, pak jej můžete spustit tak, že jej nastavíte jako svůj deploy command. Například npm run deploy.

Mezi další příkazy pro nasazení, které můžete nastavit, patří:

Příklad příkazu Popis
npx wrangler deploy --assets ./public/ Nasaďte svůj Worker společně se statickými assets ze zadaného adresáře. Případně můžete použít vazba assets.
npx wrangler deploy --env staging Pokud máte Prostředí Wrangleru Worker byste měli nastavit příkaz pro nasazení s příznakem prostředí (environment flag). Podrobnosti najdete v Pokročilá nastavení.
npx wrangler deploy --containers-rollout=immediate Containers režim postupného nasazení pro toto nasazení. Přečtěte si Rollouty.
npx wrangler deploy --containers-rollout=none Nasaďte pouze Worker. Přeskočte sestavení/push image kontejneru a rollout instancí.

Příkaz pro nasazení neprodukční větve

Příkaz pro nasazení neprodukční větve lze použít pouze v případě, že jste povolili sestavení neprodukčních větví.

Výchozí hodnota je npx wrangler versions upload, což vytvoří URL náhledu. Podobně jako příkazy build a deploy lze i tento upravit tak, aby místo toho spouštěl cokoli jiného.

Mezi další příkazy pro nasazení neprodukčních větví, které můžete nastavit, patří:

Příklad příkazu Popis
yarn exec wrangler versions upload Můžete přizpůsobit správce balíčků použitý ke spouštění Wrangleru.
npx wrangler versions upload --env staging Pokud máte Prostředí Wrangleru Worker byste měli nastavit příkaz pro nasazení neprodukční větve s příznakem prostředí. Podrobnosti najdete v Pokročilá nastavení.

Automatická konfigurace pro nové projekty

Pokud váš repozitář neobsahuje konfigurační soubor Wrangler, příkaz pro nasazení (wrangler deploy) spustí automatická konfigurace projektu. Tím se detekuje váš framework, vytvoří se potřebná konfigurace a otevře se pull request ke kontrole. Jakmile PR sloučíte, váš projekt je nakonfigurován a další buildy se budou nasazovat běžným způsobem.

API token

Token API ve Workers Builds určuje přístup, který má Workers Builds k interakci se zdroji vašeho účtu. V současnosti jsou podporovány pouze uživatelské tokeny, podpora tokenů vlastněných účtem se chystá.

Když vyberete Vytvoření nového tokenu, automaticky se vytvoří nový token API s následujícími oprávněními:

Oprávnění tohoto API tokenu můžete nakonfigurovat přechodem na My Profile > API Tokens pro uživatelské tokeny.

Doporučuje se používat stále stejný API token pro všechna nahrání a nasazení Workeru, aby byla zachována konzistentní oprávnění přístupu.

Podpora frameworků

Statické prostředky a frameworky jsou nyní v Cloudflare Workers podporovány. Postup nastavení projektů Workers a příkazy pro jednotlivé frameworky najdete v příručkách k jednotlivým frameworkům:

Proměnné prostředí

Svému sestavení můžete poskytnout vlastní proměnné prostředí.

Chcete-li přidat proměnné prostředí přes dashboard:

  1. V dashboardu Cloudflare přejděte na Workers & Pages stránce.
Přejděte na Workers & Pages ↗
  1. V Přehled, vyberte svého Workera.
  2. Vyberte Nastavení > Proměnné prostředí.

Chcete-li přidat proměnné prostředí pomocí Wrangler, definujte text a JSON přes [vars] konfigurace ve vašem souboru Wrangler.

{
	"$schema": "./node_modules/wrangler/config-schema.json",
	"name": "my-worker-dev",
	"vars": {
		"API_HOST": "example.com",
		"API_ACCOUNT_ID": "example_user",
		"SERVICE_X_DATA": {
			"URL": "service-x-api.dev.example",
			"MY_ID": 123
		}
	}
}
"$schema" = "./node_modules/wrangler/config-schema.json"
name = "my-worker-dev"

[vars]
API_HOST = "example.com"
API_ACCOUNT_ID = "example_user"

  [vars.SERVICE_X_DATA]
  URL = "service-x-api.dev.example"
  MY_ID = 123

Výchozí proměnné

Následující proměnné systémového prostředí se ve výchozím nastavení vkládají automaticky (lze je ale přepsat):

Proměnná prostředí Vložená hodnota Příklad případu použití
CI true Změna chování buildu při spuštění v CI oproti lokálnímu spuštění
WORKERS_CI 1 Změna chování buildu při spuštění ve Workers Builds oproti lokálnímu spuštění
WORKERS_CI_BUILD_UUID <build-uuid-of-current-build> Předávání Build UUID do vlastních workflow
WORKERS_CI_COMMIT_SHA <sha1-hash-of-current-commit> Předávání aktuálního ID commitu do nástroje pro hlášení chyb, například Sentry
WORKERS_CI_BRANCH <branch-name-from-push-event Přizpůsobení sestavení podle větve, například vypnutí ladicího protokolování na production