INTEGRITY Dokumentace

Migrace webu založeného na Jekyllu z GitHub Pages

V tomto tutoriálu se naučíte, jak migrovat existující Web GitHub Pages využívající Jekyll na Cloudflare Pages. Jekyll patří mezi nejoblíbenější generátory statických webů používané s GitHub Pages a přechod z webu GitHub Pages na Cloudflare Pages zabere jen několik kroků.

Tento tutoriál vás provede:

  1. Přidání potřebných závislostí, které GitHub Pages používá, do konfigurace projektu.
  2. Vytvoření nového webu Cloudflare Pages propojeného s existujícím repozitářem GitHub.
  3. Sestavení a nasazení vašeho webu na Cloudflare Pages.
  4. (Volitelné) Migrace vlastní domény.

Včetně doby sestavení by vám dokončení tohoto tutoriálu mělo zabrat méně než 15 minut.

Než začnete

Tento tutoriál předpokládá:

  1. Máte existující web GitHub Pages využívající Jekyll
  2. Máte určité zkušenosti s používáním nástrojů příkazové řádky jazyka Ruby a máte nainstalováno gem a bundle nainstalovaný.
  3. Znáte několik základních operací Git, včetně add, commit, push, a pull.
  4. Přečetli jste si Začínáme průvodce pro Cloudflare Pages.

Pokud nemáte Rubygems (gem) nebo Bundler (bundle) nainstalovaný na vašem počítači, přečtěte si instalační příručky pro Rubygems a Bundler.

Příprava repozitáře GitHub Pages

Váš existující repozitář založený na Jekyll musí specifikovat Gemfile (konfigurační soubor závislostí Ruby), aby Cloudflare Pages mohl tyto závislosti stáhnout a nainstalovat během krok sestavení.

Konkrétně budete muset vytvořit Gemfile a nainstalujte github-pages gem, který obsahuje všechny závislosti očekávané prostředím GitHub Pages.

Verze 2 sestavovacího prostředí Pages použije Ruby 3.2.2 pro výchozí sestavení Jekyll. Ujistěte se, že je vaše lokální vývojové prostředí kompatibilní.

Nastavení verze Ruby
brew install [email protected]
export PATH="/usr/local/opt/[email protected]/bin:$PATH"
Vytvořte Gemfile
cd my-github-pages-repo
bundle init

Otevřete Gemfile který pro vás byl vytvořen, a na konec souboru přidejte následující řádek:

Zadání verze github-pages
gem "github-pages", group: :jekyll_plugins

Váš Gemfile by měl vypadat takto:

# frozen_string_literal: true

source "https://rubygems.org"

git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

# gem "rails"
gem "github-pages", group: :jekyll_plugins

Spustit bundle update, který nainstaluje github-pages gem za vás a vytvoří Gemfile.lock soubor s vyřešenými verzemi závislostí.

Spuštění bundle update
bundle update
# Bundler will show a lot of output as it fetches the dependencies

Mělo by proběhnout úspěšně. Pokud ne, ověřte, že jste zkopírovali github-pages řádek přesně tak, jak je uvedený výše, a že jste ho nezakomentovali úvodním #.

Nyní musíte tyto soubory commitnout do svého repozitáře, aby na ně mohl Cloudflare Pages v následujících krocích odkazovat:

Proveďte commit souborů Gemfile a Gemfile.lock
git add Gemfile Gemfile.lock
git commit -m "deps: added Gemfiles"
git push origin main

Konfigurace projektu Pages

Jakmile váš projekt GitHub Pages explicitně definuje své závislosti, můžete začít konfigurovat Cloudflare Pages. Postup je téměř totožný s nasazení webu Jekyll.

Chcete-li nasadit svůj web do Pages:

  1. V dashboardu Cloudflare přejděte na Workers & Pages stránce.

    Přejděte na Workers & Pages ↗
  2. Vyberte Vytvoření aplikace > Pages > Importujte existující repozitář Git.

  3. Vyberte nově vytvořený repozitář GitHub a v Nastavení sestavení a nasazení sekci uveďte následující informace:

Konfigurační možnost Hodnota
Produkční větev main
Příkaz sestavení jekyll build
Adresář sestavení _site

Jakmile nakonfigurujete web, můžete spustit první nasazení. Měli byste vidět, jak Cloudflare Pages instaluje jekyll, závislosti projektu a sestavuje web, než ho nasadí.

Po nasazení webu získáte pro svůj projekt jedinečnou subdoménu na *.pages.dev. Pokaždé, když do svého webu Jekyll committnete nový kód, Cloudflare Pages automaticky znovu sestaví váš projekt a nasadí ho. Získáte také přístup k náhledová nasazení u nových pull requestů, takže si můžete prohlédnout, jak změny na vašem webu vypadají, než je nasadíte do produkce.

Migrace vlastní domény

Pokud používáte vlastní doména s GitHub Pages, musíte aktualizovat své DNS záznamy tak, aby směřovaly na nové nasazení Cloudflare Pages. Bude proto nutné upravit CNAME záznam u DNS poskytovatele vaší domény tak, aby směřoval na <your-pages-site>.pages.dev, přičemž nahraďte <your-username>.github.io.

Mějte na paměti, že než se tato změna projeví, může nějakou dobu trvat, než vyprší platnost DNS mezipamětí. Závisí to na hodnotě DNS TTL (time to live), kterou jste nastavili při původním vytváření záznamu.

Viz přidání vlastní domény sekci průvodce Začínáme, kde najdete seznam podrobných kroků.

Co dál?