🥇Wéi verbënnt GitLab a Pantheon an optiméiert Drupal a WordPress Workflows

Eis Gaaschttwéckler Tools Creator bei Pantheon schwätzt iwwer wéi een WordPress Deployment automatiséiert mat GitLab CI / CD.

В Pantheon Ech schaffen an Entwéckler Bezéiungen, also sinn ech ëmmer op der Sich no neie Weeër fir WordPress an Drupal Entwéckler ze hëllefen d'Automatiséierungsproblemer an hire Workflows ze léisen. Fir dëst ze maachen, experimentéiere ech gär mat neien Tools a kombinéiere se matenee fir effektiv ze schaffen.

Ech gesinn dacks Entwéckler mat engem eenzegen Staging Server kämpfen.

Et ass sou eng Freed fir op Ären Tour ze waarden fir en Zwëschenserver ze benotzen oder Clienten eng URL mat der Notiz ze schécken: "Kuckt hei, awer kuckt nach net hei."

Multidev Ëmfeld - ee vun de coole Pantheon Tools - léist dëse Problem, well mat hinnen kënnt Dir Ëmfeld fir Git Filialen op Ufro erstellen. All Multidev Ëmfeld huet seng eege URL an Datebank, sou datt d'Entwéckler roueg kënne schaffen, d'Qualitéit kontrolléieren an d'Zoustëmmung kréien ouni openeen op d'Zänn ze trëppelen.

Awer Pantheon huet keng Tools fir Versiounskontroll oder kontinuéierlech Integratioun an Deployment (CI / CD). Awer et ass eng flexibel Plattform mat där Dir all Tools integréiere kënnt.

Ech hunn och gemierkt datt Teams verschidde Tools fir Entwécklung benotzen, a verschidde fir Assemblée an Deployment.

Zum Beispill hu se verschidden Tools fir Versiounskontroll an CI / CD. Dir musst ronderëm fidderen an tëscht Tools wiesselen fir Code z'änneren an Probleemer ze diagnostizéieren.

op GitLab et gëtt e komplette Set vun Entwécklungsinstrumenter: fir Versiounskontrolle, Ticketen, Fusiounsufroen, eng bescht-an-Klass CI/CD Pipeline, e Containerregistrierung, an alles wéi dat. Ech sinn nach net op eng Applikatioun begéint déi sou vill bitt fir Ären Entwécklungsworkflow ze managen.

Ech hunn d'Automatisatioun gär, also hunn ech geléiert wéi ech Pantheon mat GitLab verbannen, sou datt Verpflichtungen fir d'Haaptzweig op GitLab an d'Haaptentwécklungsëmfeld am Pantheon ofgesat ginn. A Fusiounsufroen op GitLab kënne Code op Multidev Ëmfeld am Pantheon erstellen an ofsetzen.

An dësem Tutorial ginn ech Iech duerch wéi Dir eng Verbindung tëscht GitLab a Pantheon opstellt an Äre WordPress an Drupal Workflow optiméiert.

Natierlech ass et méiglech, Mirror GitLab Repository, mee mir wäerten alles mat eisen Hänn maachen fir ze verdéiwen GitLab CI an an Zukunft benotzt dëst Tool net nëmme fir Ofbau.

Aféierung

Fir dëse Post musst Dir verstoen datt Pantheon all Site an dräi Elementer brécht: Code, Datebank a Dateien.

De Code enthält CMS Dateien wéi WordPress Kär, Plugins, an Themen. Dës Dateie ginn an Git Repositories, gehost vum Pantheon, dat heescht datt mir Code vu GitLab op Pantheon mat Git ofsetzen kënnen.
Dateien am Pantheon si Mediendateien, dat heescht Biller fir de Site. Typesch gi se vu Benotzer eropgelueden an Git ignoréiert se.

Schafen eng gratis Kont, gewuer méi iwwer Pantheon Workflow oder aschreiwen fir eng Demo bei pantheon.io.

Viraussetzungen

Mäi Projet op Pantheon a GitLab heescht pantheon-gitlab-blog-demo. De Projet Numm muss eenzegaarteg sinn. Hei wäerte mir mat engem WordPress Site schaffen. Dir kënnt Drupal huelen, awer Dir musst e puer Saachen änneren.

Ech wäert benotzen Gitt Kommandozeilan Dir kënnt schaffen an grafeschen Interface, Wanns du wëlls.

Schafen engem Projet

Als éischt, loosst eis erstellen GitLab Projet (mir kommen herno drop zréck).

Elo eng WordPress Websäit op Pantheon erstellen. Da installéiere mir WordPress fir de Site Dashboard.

Wann Är Hänn Jucken fir eppes z'änneren, zum Beispill Plugins erofhuelen oder addéieren, sidd Gedold. De Site ass nach net mat GitLab verbonnen, a mir wëllen datt all Code Ännerungen duerch GitLab goen.

Wann mir WordPress installéieren, gitt zréck op de Pantheon Websäit Dashboard an ännert den Entwécklungsmodus op Git.

Éischt Verpflichtung op GitLab

Elo musst Dir den initialen WordPress Code vun der Pantheon Site op GitLab transferéieren. Fir dëst ze maachen, klone mir de Code vum Git Repository vum Pantheon Site lokal, a schécken et dann an de GitLab Repository.

Fir et méi einfach a méi sécher ze maachen, füügt en SSH Schlëssel op Pantheon a mir mussen net e Passwuert aginn all Kéier wann mir e Pantheon Git Repository klonen. Gläichzäiteg schonn füügt en SSH Schlëssel op GitLab.

Fir dëst ze maachen, klon de Pantheon Site lokal andeems Dir de Kommando aus dem Clone with Git Feld op dem Site Dashboard kopéiert.

Wann Dir Hëllef braucht, liest d'Dokumentatioun Start mat Git fir Pantheon.

Loosst eis elo änneren git remote originop GitLab ze weisen amplaz Pantheon. Et kann gemaach ginn командой git remote.

Loosst eis op de GitLab Projet goen a kopéieren d'Repository URL vum Clone Dropdown op der Projet Detailer Säit. Loosst eis d'Klon mat SSH Optioun wielen, well mir de SSH Schlëssel scho konfiguréiert hunn.

Par défaut git remote fir eng lokal Kopie vum Code Repository - origin. Dëst kann geännert ginn c git remote set-url origin [URL репозитория GitLab], wou mir amplaz vun Klammern déi aktuell URL aginn.

Endlech lancéiere mir git push origin master --forcefir WordPress Code vum Pantheon op GitLab ze drécken.

D'-force Optioun ass nëmmen eemol gebraucht. Dann an Équipen git push et wäert net op GitLab sinn.

Umeldungsinformatiounen a Variabelen opzestellen

Erënnert Dir Iech wéi mir en SSH-Schlëssel lokal bäigefüügt hunn fir op Pantheon a GitLab anzeloggen? Den SSH Token ka benotzt ginn fir GitLab a Pantheon ze autoriséieren.

GitLab huet exzellent Dokumentatioun. Mol kucken Sektioun iwwer SSH Schlësselen wann Dir den Docker Exekutor am Dokument benotzt fir SSH Schlësselen mat GitLab CI / CD ze benotzen.

Mir wäerten elo déi éischt zwee Schrëtt fäerdeg maachen: Loosst eis en neit SSH Schlësselpaar lokal mat ssh-keygen erstellen an de private Schlëssel als Variabel zum Projet addéieren.

Da froe mer SSH_PRIVATE_KEY wéi GitLab CI / CD Ëmfeld Variabel an de Projet Astellungen.
Am drëtten a véierte Schrëtt wäerte mir eng Datei erstellen .gitlab-ci.yml mat Inhalt wéi dësen:

before_script:
  # See https://docs.gitlab.com/ee/ci/ssh_keys/README.html
  - eval $(ssh-agent -s)
  - echo "$SSH_PRIVATE_KEY" | tr -d 'r' | ssh-add - > /dev/null
  - mkdir -p $HOME/.ssh && echo "StrictHostKeyChecking no" >> "$HOME/.ssh/config"
  - git config --global user.email "$GITLAB_USER_EMAIL"
  - git config --global user.name "Gitlab CI"

Loosst eis de Fichier nach net engagéieren .gitlab-ci.yml, da musst Dir nach eppes derbäisetzen.

Elo maache mir de fënnefte Schrëtt an füügt den ëffentleche Schlëssel un, deen Dir am éischte Schrëtt erstallt hutt, fir d'Servicer op déi Dir braucht Zougang zu der Build-Ëmfeld.

An eisem Fall wëlle mir Zougang zu Pantheon vu GitLab. Mir verfollegen d'Instruktioune am Pantheon Dokument op en SSH Schlëssel op Pantheon dobäizemaachen a maachen dëse Schrëtt.

Denkt drun: privat SSH ass am GitLab, oppen SSH ass am Pantheon.

Loosst eis e puer méi Ëmfeldvariablen opsetzen. Déi éischt ass PANTHEON_SITE genannt. Säi Wäert ass den Numm vum Pantheon Site op Ärer Maschinn.

Den Numm op der Maschinn gëtt um Enn vum Clone mat Git Kommando opgelëscht. Dir hutt de Site scho lokal gekloont, sou datt dëst den Numm vum lokale Repository-Verzeichnis ass.

Als nächst, loosst eis d'Ëmfeldvariabel opsetzen PANTHEON_GIT_URL. Dëst ass d'Git Repository URL fir de Pantheon Site déi mir scho benotzt hunn.

Gitt nëmmen d'SSH Repository URL un, ouni git clone an den Numm vum Site op der Maschinn um Enn.

Pff. Dat ass fäerdeg, elo kënne mir eisen Dossier fäerdeg maachen .gitlab-ci.yml.

Erstellt eng Deployment Task

Wat mir ufanks mat GitLab CI maachen ass ganz ähnlech wéi wat mir mat Git Repositories an der Vergaangenheet gemaach hunn. Awer dës Kéier, loosst eis de Pantheon Repository als eng zweet Remote Git Quell addéieren, an dann de Code vu GitLab op Pantheon drécken.

Fir dëst ze maachen, loosst eis konfiguréieren Stuf deploy и Aufgab deploy:dev, well mir an d'Entwécklungsëmfeld op Pantheon ofsetzen. Déi resultéierend Datei .gitlab-ci.yml wäert esou ausgesinn:

stages:
- deploy

before_script:
  # See https://docs.gitlab.com/ee/ci/ssh_keys/README.html
  - eval $(ssh-agent -s)
  - echo "$SSH_PRIVATE_KEY" | tr -d 'r' | ssh-add - > /dev/null
  - mkdir -p $HOME/.ssh && echo "StrictHostKeyChecking no" >> "$HOME/.ssh/config"
  - git config --global user.email "$GITLAB_USER_EMAIL"
  - git config --global user.name "Gitlab CI"

deploy:dev:
  stage: deploy
  environment:
    name: dev
    url: https://dev-$PANTHEON_SITE.pantheonsite.io/
  script:
    - git remote add pantheon $PANTHEON_GIT_URL
    - git push pantheon master --force
  only:
    - master

Verännerlechen SSH_PRIVATE_KEY, PANTHEON_SITE и PANTHEON_GIT_URL sollt vertraut ausgesinn - mir hunn dës Ëmfeldvariablen fréier opgestallt. Mat dëse Variablen kënne mir d'Wäerter an der Datei benotzen .gitlab-ci.yml vill Mol, a si mussen nëmmen op enger Plaz aktualiséiert ginn.

Endlech, addéieren, engagéieren a schéckt d'Datei .gitlab-ci.yml op GitLab.

Iwwerpréift d'Verbreedung

Wa mir alles richteg gemaach hunn, ass d'Aufgab deploy:dev wäert erfollegräich am GitLab CI / CD lafen an en Engagement ofginn .gitlab-ci.yml am Pantheon. Loosst eis kucken.

Schéckt Fusiounsufro Threads op Pantheon

Hei wäerte mir meng Liiblings Pantheon Feature benotzen - multidev, wou Dir zousätzlech Pantheon Ëmfeld fir Git Filialen op Ufro erstellen kënnt.

Zougang zu multidev ass limitéiert, also kann dës Sektioun iwwersprangen ginn. Awer wann Dir Zougang hutt, kënnt Dir d'Produktivitéit eescht erhéijen andeems Dir automatesch Kreatioun vu Multidev Ëmfeld op Pantheon vu GitLab Fusiounsufroen opstellt.

Loosst eis als éischt eng nei Git Branche lokal benotzen git checkout -b multidev-support. Loosst eis elo erëm eppes änneren .gitlab-ci.yml.

Ech hu gär d'Fusiounsufronummer am Pantheon-Ëmfeldnumm abegraff. Zum Beispill ass déi éischt Fusiounsufro mr-1, zweeten - mr-2 etc.

D'Fusiounsufro ännert sech, also musse mir dynamesch d'Nimm vun de Pantheon Branchen bestëmmen. Et ass einfach op GitLab - Dir musst just benotzen virdefinéiert Ëmweltvariablen.

Mir kënnen huelen $CI_MERGE_REQUEST_IIDfir d'Fusiounsufronummer ze spezifizéieren. Loosst eis dat alles zesumme mat de globalen Ëmfeldvariablen uwenden, déi mir virdru spezifizéiert hunn an eng nei Deploy:multidev Task um Enn vun der Datei bäidroen .gitlab-ci.yml.

deploy:multidev:
  stage: deploy
  environment:
    name: multidev/mr-$CI_MERGE_REQUEST_IID
    url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
  script:
    # Checkout the merge request source branch
    - git checkout $CI_COMMIT_REF_NAME
    # Add the Pantheon git repository as an additional remote
    - git remote add pantheon $PANTHEON_GIT_URL
    # Push the merge request source branch to Pantheon
    - git push pantheon $CI_COMMIT_REF_NAME:mr-$CI_MERGE_REQUEST_IID --force
  only:
    - merge_requests

Et wäert ähnlech wéi eis Aufgab sinn deploy:dev, nëmmen d'Branche gëtt op Pantheon geschéckt, net fir master.

Mir hunn déi aktualiséiert Datei bäigefüügt an engagéiert .gitlab-ci.yml, an elo drécke mir eng nei Branche op GitLab mat git push -u origin multidev-support.

Loosst eis elo eng nei Fusiounsufro vun der Branche erstellen multidev-supportduerch dréckt Fusiounsufro erstellen.

Nodeems mir eng Fusiounsufro erstallt hunn, kucke mir wéi d'CI / CD Aufgab ausgefouert gëtt deploy:multidev.

Kuckt, en neie Fuedem gouf op Pantheon geschéckt. Awer wa mir an d'Multidev Sektioun um Pantheon Site Dashboard goen, gesi mir dat neit Ëmfeld net do

Loosst eis d'Git Branches Sektioun kucken.

Als Resultat, eise Fuedem mr-1 op Pantheon komm. Loosst eis en Ëmfeld aus enger Branche kreéieren mr-1.

Mir hunn e Multidev Ëmfeld erstallt, loosst eis zréck op GitLab goen a kucken d'Sektioun Operatiounen> Ëmfeld. Mir wäerten Entréen gesinn fir dev и mr-1.

Dëst ass well mir en Entrée bäigefüügt hunn environment Mam Numm name и url an CI / CD Aufgaben. Wa mir op d'Open Ëmfeld Ikon klickt, gi mir op d'URL vum Multidev Ëmfeld op Pantheon geholl.

Automatiséiert d'Schafung vu Multidev

Am Prinzip kënnt Dir hei stoppen an erënnere just un e Multidev Ëmfeld fir all Fusiounsufro ze kreéieren, awer dëse Prozess kann automatiséiert ginn.

Pantheon huet e Kommandozeilinstrument Terminus, wou Dir mat der Plattform automatesch schaffe kënnt. Terminus erlaabt Iech multidev Ëmfeld vun der Kommandozeil ze kreéieren - ideal fir GitLab CI.

Mir brauchen eng nei Fusiounsufro fir dëst ze testen. Loosst eis eng nei Branche erstellen mat git checkout -b auto-multidev-creation.

Fir Terminus an GitLab CI / CD Aufgaben ze benotzen, braucht Dir e Maschinntoken fir d'Authentifikatioun mat Terminus an e Containerbild mat Terminus.

Erstellt e Pantheon Machine Token, späichert et op enger sécherer Plaz a füügt se als eng global Ëmfeldvariabel am GitLab mam Numm un PANTHEON_MACHINE_TOKEN.

Wann Dir vergiess hutt wéi Dir GitLab Ëmfeldvariablen derbäi kënnt, gitt zréck op wou mir definéiert hunn PANTHEON_SITE.

Erstellt en Dockerfile mat Terminus

Wann Dir Docker net benotzt oder Dateien net gär hutt Dockerfile, huelt mäi Bild registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest a sprangen dës Sektioun.

GitLab huet e Containerregister, wou mir d'Dockerfile fir eise Projet bauen a placéieren. Loosst eis en Dockerfile mam Terminus erstellen fir mat Pantheon ze schaffen.

Terminus ass e PHP Kommandozeil Tool, also loosst eis mam PHP Bild ufänken. Ech installéieren Terminus duerch Composer, also wäert ech benotzen offiziell Docker Composer Bild. Mir kreéieren Dockerfile am lokalen Repository Verzeichnis mat dem folgenden Inhalt:

# Use the official Composer image as a parent image
FROM composer:1.8

# Update/upgrade apk
RUN apk update
RUN apk upgrade

# Make the Terminus directory
RUN mkdir -p /usr/local/share/terminus

# Install Terminus 2.x with Composer
RUN /usr/bin/env COMPOSER_BIN_DIR=/usr/local/bin composer -n --working-dir=/usr/local/share/terminus require pantheon-systems/terminus:"^2"

Follegt d'Instruktioune fir d'Biller aus der Sektioun ze montéieren an ze schécken Bauen a drécken Biller в Container Registry Dokumentatioune Bild ze sammelen aus Dockerfile an dréckt et op GitLab.

Öffnen d'Sektioun Registry am GitLab Projet. Wann alles no Plang gelaf ass, wäert eist Bild do sinn. Schreift e Link op d'Bild Tag - mir brauchen et fir de Fichier .gitlab-ci.yml.

Sektioun script am Problem deploy:multidev fänkt un ze wuessen, also loosse mer et an eng separat Datei réckelen. Erstellt eng nei Datei private/multidev-deploy.sh:

#!/bin/bash

# Store the mr- environment name
export PANTHEON_ENV=mr-$CI_MERGE_REQUEST_IID

# Authenticate with Terminus
terminus auth:login --machine-token=$PANTHEON_MACHINE_TOKEN

# Checkout the merge request source branch
git checkout $CI_COMMIT_REF_NAME

# Add the Pantheon Git repository as an additional remote
git remote add pantheon $PANTHEON_GIT_URL

# Push the merge request source branch to Pantheon
git push pantheon $CI_COMMIT_REF_NAME:$PANTHEON_ENV --force

# Create a function for determining if a multidev exists
TERMINUS_DOES_MULTIDEV_EXIST()
{
    # Stash a list of Pantheon multidev environments
    PANTHEON_MULTIDEV_LIST="$(terminus multidev:list ${PANTHEON_SITE} --format=list --field=id)"

    while read -r multiDev; do
        if [[ "${multiDev}" == "$1" ]]
        then
            return 0;
        fi
    done <<< "$PANTHEON_MULTIDEV_LIST"

    return 1;
}

# If the mutltidev doesn't exist
if ! TERMINUS_DOES_MULTIDEV_EXIST $PANTHEON_ENV
then
    # Create it with Terminus
    echo "No multidev for $PANTHEON_ENV found, creating one..."
    terminus multidev:create $PANTHEON_SITE.dev $PANTHEON_ENV
else
    echo "The multidev $PANTHEON_ENV already exists, skipping creating it..."
fi

D'Skript ass an engem privaten Dossier an erlaabt net Web Zougang zu Pantheon. Mir hunn e Skript fir eis Multidev Logik. Loosst eis elo d'Sektioun aktualiséieren deploy:multidev Datei .gitlab-ci.ymlsou datt et esou ausgeet:

deploy:multidev:
  stage: deploy
  environment:
    name: multidev/mr-$CI_MERGE_REQUEST_IID
    url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
  script:
    # Run the multidev deploy script
    - "/bin/bash ./private/multidev-deploy.sh"
  only:
    - merge_requests

Mir musse sécherstellen datt eis Aufgaben am erstallte personaliséierte Bild ausgeführt ginn, also loosst eis eng Definitioun addéieren image vun Registry URL zu .gitlab-ci.yml. Als Resultat hu mir mat engem Fichier wéi dësen opgehalen .gitlab-ci.yml:

image: registry.gitlab.com/ataylorme/pantheon-gitlab-blog-demo:latest

stages:
- deploy

before_script:
  # See https://docs.gitlab.com/ee/ci/ssh_keys/README.html
  - eval $(ssh-agent -s)
  - echo "$SSH_PRIVATE_KEY" | tr -d 'r' | ssh-add - > /dev/null
  - mkdir -p $HOME/.ssh && echo "StrictHostKeyChecking no" >> "$HOME/.ssh/config"
  - git config --global user.email "$GITLAB_USER_EMAIL"
  - git config --global user.name "Gitlab CI"

deploy:dev:
  stage: deploy
  environment:
    name: dev
    url: https://dev-$PANTHEON_SITE.pantheonsite.io/
  script:
    - git remote add pantheon $PANTHEON_GIT_URL
    - git push pantheon master --force
  only:
    - master

deploy:multidev:
  stage: deploy
  environment:
    name: multidev/mr-$CI_MERGE_REQUEST_IID
    url: https://mr-$CI_MERGE_REQUEST_IID-$PANTHEON_SITE.pantheonsite.io/
  script:
    # Run the multidev deploy script
    - "/bin/bash ./private/multidev-deploy.sh"
  only:
    - merge_requests

Füügt, engagéiert a schéckt private/multidev-deploy.sh и .gitlab-ci.yml. Elo gi mir zréck op GitLab a waart bis d'CI / CD Aufgab fäerdeg ass. Sidd Gedold: Multidev kann e puer Minutten daueren fir ze kreéieren.

Da kucke mer d'Multidev Lëscht op Pantheon. Oh Wonner! Multidev Ëmfeld mr-2 schonn hei.

Konklusioun

Meng Equipe hat vill méi Spaass wéi mir ugefaang Fusiounsufroen opzemaachen an Ëmfeld automatesch ze kreéieren.

Mat de mächtege Tools vu GitLab a Pantheon kënnt Dir GitLab automatesch mam Pantheon verbannen.

Well mir GitLab CI / CD benotzen, wäert eise Workflow Plaz hunn fir ze wuessen. Hei sinn e puer Iddien fir Iech unzefänken:

Füügt e Bauschrëtt.
Füügt automatesch Tester.
Füügt eng Aufgab fir sécherzestellen datt Codenormen erfëllt sinn.
Dobäizemaachen dynamesch Applikatioun Sécherheet Testen.

Loosst eis wëssen wat Dir iwwer GitLab, Pantheon an Automatioun denkt.

PS Wousst Dir datt Terminus, dem Pantheon Kommandozeilinstrument, kann via Plugins verlängert ginn?

Mir um Pantheon hunn eng gutt Aarbecht op Versioun gemaach 2 vun eiser Plugin fir Terminus Build Tools mat GitLab Ënnerstëtzung. Wann Dir net mat Astellunge fir all Projet beméie wëllt, probéiert dëse Plugin an hëlleft eis d'v2 Beta ze testen. Fir d'Terminus-Team build:project:create Dir braucht nëmmen e Pantheon Token an e GitLab Token. Si wäert ee vun de Probeprojete mat Composer an automatiséierter Tester ofsetzen, en neie Projet am GitLab erstellen, en neie Pantheon Site, a verbënnt se mat Ëmfeldvariablen an SSH Schlësselen.

Iwwer den Autor

Andrew Taylor erstellt Tools fir Entwéckler an Pantheon.

Source: will.com

Wéi GitLab a Pantheon ze verbannen an Drupal a WordPress Workflows optimiséieren