Validación de archivos GitLab CI con linter antes del pipeline

Clase 25 de 53 • Curso de DevOps con GitLab

Resumen

Validar la configuración de GitLab CI sin esperar a que corra un pipeline completo es clave para trabajar rápido y con confianza. Aquí verás cómo usar el linter de GitLab CI para detectar errores de sintaxis en .gitlab-ci.yml, cuáles ajustes mínimos asegurar para un Pipeline verde, y qué ocurre al integrar cambios con squash commits y merge a master.

¿Cómo validar .gitlab-ci.yml con el linter de GitLab CI?

Usar primero el linter evita perder tiempo en ejecuciones fallidas por errores de sintaxis. GitLab ofrece un validador que confirma si los keywords, el orden y la estructura del archivo .gitlab-ci.yml son correctos. Ojo: el linter valida sintaxis, no la lógica de tus scripts.

Entra al proyecto y abre el linter en la ruta: /-/ci/lint.
Copia y pega todo tu .gitlab-ci.yml y presiona Validar.
Corrige errores de sintaxis como artificts por artifacts.
Repite la validación hasta obtener “syntaxis correcta”.

Con la sintaxis lista, confirma cambios en Git:

Revisa con git status que .gitlab-ci.yml está listo para stage.
Añade y crea el commit: “add GitLab CI config”.
Firma con tu llave PGP si tu repositorio lo requiere.
Sube cambios con git push usando tu llave SSH.

¿Qué configuración mínima asegura un pipeline estable en Node?

La configuración base incluye la imagen Node 11, dos stages (Install y Test) y jobs bien encadenados mediante artifacts y dependencies. Esto garantiza que node_modules se comparta correctamente y que las pruebas corran sin reinstalar todo en cada job.

Imagen base: Node 11.
Stages: Install y Test.
Job “Install dependencies”: instala dependencias y las exporta como artifacts para los siguientes jobs.
Uso de cache para evitar reinstalaciones de node_modules.
Job de tests: pertenece a stage “test” y depende de “install dependencies” vía dependencies para consumir node_modules.

Ajustes críticos en el job de pruebas:

before_script: instalar Chrome correctamente. Corregir “app get” por apt-get update y usar && en lugar de &&&.
script: ejecutar npm run test CI en lugar de “npm test CI”.
variables: declarar la variable de ambiente que apunta al binario de Chrome para que Karma ejecute en Chrome Headless. Sin esto, los tests no corren.

Ideas clave que garantizan estabilidad:

El linter detecta sintaxis, pero no errores en los scripts.
Artifacts y dependencies conectan jobs y comparten node_modules.
Cache acelera el pipeline evitando reinstalaciones.
Chrome Headless permite correr pruebas sin interfaz gráfica.
npm run test CI respeta la convención de npm scripts.

¿Qué sucede tras un pipeline verde y el merge a master?

Desde el menú de Pipelines verás primero el job de instalación y la subida de artifacts. Luego el job de tests instala Chrome y ejecuta las pruebas. Al terminar con “tres success”, el widget del merge request muestra el Pipeline en verde.

Cambios revisados antes de integrar:

Añadir .gitlab-ci.yml con toda la configuración.
Agregar un script en package.json para pruebas.
Configurar Karma para correr en Chrome Headless.

Buenas prácticas al integrar:

Resolver el estado WIP cuando el pipeline está verde.
Hacer squash commits para mantener un historial claro.
Borrar el branch tras el merge.

Tras confirmar el merge, se detona automáticamente un pipeline en master porque la configuración ya vive ahí. Esto consolida el primer paso de Continuous Integration: con cada commit se instalan dependencias y corren los tests. Más adelante podrás integrar Continuous Deployment y Continuous Delivery dentro de tu flujo de development.

¿Te gustaría comentar cómo declaras tus variables o cómo optimizas el uso de artifacts y cache en tus pipelines de GitLab CI?

Luis Moncaris

student•

Linter Gitlab CI https://gitlab.com/<group>/<project_name>/-/ci/lint

Carlos Oliveros

student•

correcto.

Antonio Obregón

student•

Wow, tambien esta disponible para versiones self-management on premise

José de Jesús Uscanga Molina

student•

Con un proyecto hecho en React con create-react-app

Modifique el package.json

{
  "name": "gitlab",
  "version": "0.1.0",
  "private": true,
  "dependencies": {
    "react": "^16.9.0",
    "react-dom": "^16.9.0",
    "react-scripts": "3.1.1"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "test:ci": "react-scripts test --watchAll=false",
    "eject": "react-scripts eject"
  },
  "eslintConfig": {
    "extends": "react-app"
  },
  "browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  }
}```

Archivo `gitlab-ci.yml`

```yml
image: node:10.16-alpine

stages:
  - install
  - test

job-install:
  stage: install
  script:
    - npm install
  artifacts:
    expire_in: 1hr
    paths:
      - node_modules/
  cache:
    paths:
      - node_modules/

job-test:
  stage: test
  dependencies:
    - job-install
  script:
    - npm run test:ci

Algo base, me imagino que hay de ver cosas mas PRO

Pedro Luis Méndez Yépez

student•

En mi caso no tenía test, así me tocó agregar algo adicional

"test:ci": "react-scripts test --watchAll=false --passWithNoTests",

Wilmer Ariel Moina Rivera

student•

image: node:10.17.0
stages:
  - install
  - test
install-dependencies:
  stage : install
  script:
    - npm install
    - npm install --save-dev puppeteer
  artifacts:
    expire_in: 1hr
    paths: 
      - node_modules/
  cache: 
     paths:
      - node_modules/
test-apps:
  stage: test
  variables:
    CHROME_BIN: google-chrome
  dependencies:
   - install-dependencies
  before_script:
   - apt-get update && apt-get install -y apt-transport-https
   - wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | apt-key add -
   - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
   - apt-get update && apt-get install -y google-chrome-stable
  script:
   - npm run test:ci

Cristian Gaona

student•

Con estas configuraciones funciona perfectamente el pipeline

Karma.conf.js

 browsers: ["Chrome", "ChromeHeadless", "ChromeHeadlessCI"],
    customLaunchers:{
        ChromeHeadlessCI: {
          base: 'ChromeHeadless',
          flags: ['--no-sandbox']
        }
    },

package.json

"test:ci": "ng test --no-watch --browsers=ChromeHeadlessCI",

.gitlab-ci.yml

image: node:14.15.4
stages:
  - install
  - test

install-dependencies:
  stage: install
  script:
    - npm install
  artifacts:
    expire_in: 1hr
    paths:
      - node_modules
  cache:
    paths:
      - node_modules

test-apps: 
  stage: test
  variables:
      CHROME_BIN: google-chrome
  dependencies:
    - install-dependencies
  before_script:
    - apt-get update && apt-get install -y apt-transport-https
    - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
    - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
    - apt-get update && apt-get install -y google-chrome-stable
  script:
    - npm run test:ci

Manuel Felipe García Rincón

student•

Funcionó perfecto, llevaba ya horas intentando de todo, hasta que vi tu comentario.

Rafael Vilches

student•

genial, el anterior archivo .gitlab-ci.yml mandaba error con el texto: cache, al revisarlo en lint

Sebastian Londoño

student•

con esta linea en package.json

    "test:ci": "ng test --watch=false --browsers=ChromeHeadlessNoSandbox",

y esta version del gitlab-ci, funciono sin problema,

image: node:12.18.3
stages:
  - install
  - test

install-dependencies:
  stage: install
  script:
    - npm install
  artifacts:
    expire_in: 1hr
    paths:
      - node_modules/
  cache:
    paths:
      - node_modules/

test-apps:
  stage: test
  variables:
    CHROME_BIN: google-chrome
  dependencies:
    - install-dependencies
  before_script:
    - apt-get update && apt-get install -y apt-transport-https
    - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
    - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
    - apt-get update && apt-get install -y google-chrome-stable
  script:
    - npm run test:ci

Gabriel Oswaldo Giraldo Martínez

student•

Después de mucho rato tratando veo tu comentario y todo me funcionó. Muchas gracias por el aporte

Formacion 06

student•

Se puede generar un pipeline para una rama específica?

Israel Yance

student•

Claro que sí. Ya que no se puede hacer merge a master sin antes verificar que todo está correcto con esa rama.

Gonzalo Amador Hernández

student•

puedes restringir el Job para las ramas que decidas, con la pabra clave only:

stages:
  - build

build:
  stage: build
  script:
    - my-scripts
  only:
    - master

Asi solo el Job llamado build del satege llamado build solo se ejecurara en master

Jesus David Posada Escobar

student•

En la compañía para la que trabajo usamos GitLab CI pero con el ejecutor es SSH, así se ve unos de los .yml, adicionalmente usamos playbooks de ansible para ejecutar algunas tareas predefinidas

stages:
  - build
  - test
  - registry
  - deployment
  - performance
  - destroy

variables:
  GIT_STRATEGY: none
  GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_PROJECT_NAME/$CI_COMMIT_REF_NAME/
  DOMAIN: mi-aplicativo.com/wss

include:
  - build/docker.yml
  - verify/unit-testing.yml
  - security/code-quality.yml
  - artifact/registry.yml
  - verify/performance-testing.yml

develop:
  stage: deployment
  only:
    - develop
  inherit:
    variables: false
  trigger:
    project: playbooks/miapp-playbook
    strategy: depend
  variables:
    IMAGE: midockerhub/$CI_PROJECT_NAME:$CI_COMMIT_REF_SLUG
    ENV: develop

QA:
  stage: deployment
  only:
    - /^release/.*$/
  inherit:
    variables: false
  trigger:
    project: playbooks/miapp-playbook
    strategy: depend
  variables:
    IMAGE: midockerhub/$CI_PROJECT_NAME:$CI_COMMIT_REF_SLUG
    ENV: qa

staging:
  stage: deployment
  only:
    - tags
  inherit:
    variables: false
  trigger:
    project: playbooks/miapp-playbook
    strategy: depend
  variables:
    IMAGE: midockerhub/$CI_PROJECT_NAME:$CI_COMMIT_REF_SLUG
    ENV: staging

production:
  stage: deployment
  when: manual
  only:
    - tags
  inherit:
    variables: false
  trigger:
    project: playbooks/miapp-playbook
    strategy: depend
  variables:
    IMAGE: midockerhub/$CI_PROJECT_NAME:$CI_COMMIT_REF_SLUG
    ENV: production

Manuel Pita

student•

Buenas, he tratado de aplicar los paso como lo indica y no me funcionaron, y me imagino que por el tiempo que fue grabado debe llevar como un años.

Para que le funciones la configuración del CI con angular Angular CLI: 10.0.6

el fichero .gitlab-ci.yml debe tener una ligeras modificaciones:

image: node:12.18.3
stages:
  - install
  - test

install-dependencies:
  stage: install
  script:
    - npm install
  artifacts:
    expire_in: 1hr
    paths:
      - node_modules/
  cache:
    paths:
      - node_modules/

test-apps:
  stage: test
  variables:
    CHROME_BIN: google-chrome
  dependencies:
    - install-dependencies
  before_script:
    - apt-get update && apt-get install -y apt-transport-https
    - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
    - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
    - apt-get update && apt-get install -y google-chrome-stable
  script:
    - npm run test:ci

Y el el fichero package.json cambiar el test:ci por:

"test:ci": "ng test --no-watch --no-progress --browsers=ChromeHeadlessCI",

así debería funcionar sin ningún error.

Victor bustos sazo

student•

Qué sucede cuando hay distintas versiones de .gitlab-ci.yml en cada rama. Se utilizan las opciones de skip-ci en el commit? Alguna sugerencia de cómo gestionarlo por favor

Dany Pascual Gomez Sanchez

student•

<---------------------------------------------------------------------
ITERACCION BASICA:
---------------------------------------------------------------------

    1. CREAR REPO

    2. EN LOCAL ENTRAR AL DIRECTORIO DEL PROYECTO

    3. EJECUTAR: 
        - git init
        - git config --global user.name "Dany Pascual Gómez Sánchez"
        - git config --global user.email "pascualdas@gmail.com"
        - git remote add origin git@gitlab.com:personal0713/helloworld.git
        - git pull origin master

    4. CREAR ISSUE EN GitLab => #id = 1

    5. CAMBIOS LOCALES =>

        - Hacer cambios.
        - git branch "1-branch"
        - git checkout 1-branch
        - git add -A
        - git commit -m "1-commitName"
        - git push origin 1-branch

    6. EN GttLab

        - TEST .gitlab-ci.yml => CI / CD => PipeLines => CI Lint => Probamos comandos

        - voy al issue 1
        - abro la rama 1-branch
        - creo merge request
        - voy a merge requests => MERGE + Delete sourge branch => se cierra el merge request y el issue automatico.
        
    7. Local:

        - git checkout master
        - git branch -D 1-branch
        - git pull origin master

    8. INICIAMOS EN PUNTO 1

--------------------------------------------------------------------->

Ebenezer Silvestre Diaz Garcia

student•

me manda un error al correr el TEST cuando corre el pipeline en Gitlab, en mi local las pruebas funcionan bien:

27 09 2019 04:02:27.143:INFO [karma-server]: Karma v4.1.0 server started at http://0.0.0.0:9876/
27 09 2019 04:02:27.150:INFO [launcher]: Launching browsers ChromeHeadlessNoSandbox with concurrency unlimited
27 09 2019 04:02:27.975:INFO [launcher]: Starting browser ChromeHeadless
27 09 2019 04:03:27.977:WARN [launcher]: ChromeHeadless have not captured in 60000 ms, killing.
27 09 2019 04:03:29.979:WARN [launcher]: ChromeHeadless was not killed in 2000 ms, sending SIGKILL.
27 09 2019 04:03:31.979:WARN [launcher]: ChromeHeadless was not killed by SIGKILL in 2000 ms, continuing.
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! platzi-devops@0.0.0 test:ci: `ng test --watch=false --browsers=ChromeHeadlessNoSandbox`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the platzi-devops@0.0.0 test:ci script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2019-09-27T04_03_32_021Z-debug.log
ERROR: Job failed: exit code 1

Ebenezer Silvestre Diaz Garcia

student•

Ya lo resolvi, resulta que era un Enter que se habia colado al final del archivo .gitlab-ci.yml

Carlos Andres Quintero Sotelo

student•

Quisiera reportar un problema que tengo a la hora de correr mi test el cual se genera porque yo uso Windows y la configuración que esta intentando buscar según veo es para una ruta de un SO linux - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/stable main" >> /etc/app/sources.list.d/google.list' Quisiera saber que ruta debo indicar cuando realizo todo el proceso desde un windows

Nahum Manuel Martín Vegas

student•

Esta versión me funciona a mi a fecha de hoy:

image: node:lts
stages:
  - install
  - test

install-dependencies:
  stage: install
  script:
    - npm install
  artifacts:
    expire_in: 1hr
    paths:
      - node_modules/
  cache:
    paths:
      - node_modules/

test-apps:
  stage: test
  variables:
    CHROME_BIN: google-chrome
  dependencies:
    - install-dependencies
  before_script:
    - apt-get update && apt-get install -y apt-transport-https
    - wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | tee /etc/apt/trusted.gpg.d/google.asc >/dev/null
    - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
    - apt-get update && apt-get install -y google-chrome-stable
  script:
    - npm run test:ci

Gonzalo Amador Hernández

student•

Para validar el archivo .gitlab-ci.yml puedes hacerlo de dos formas

usando GitLab

Navega a CI/CD > Pipelines o CI/CD > Jobs en tu proyecto
Despues has click en CI lint
Pega tu codigo en el editor
preciona el boton Validate

usando la extension de GitLab en vscode

Instala la extension gitlab.gitlab-workflow
Abre el command palette (ctrl + shift + p o cmd + shift + p)
Ejecuta el comando GitLab: Validate GitLab CI config

Edgar Moises Valdez Faria

student•

Por si alguien tuvo errores con las nuevas versiones de karma:

el gitlab-ci.yml

image: node:12.18.2

stages:
  - install
  - test

install-dependencies:
  stage: install
  script:
    - npm install
  artifacts:
    expire_in: 1hr
    paths:
      - node_modules/
  cache:
    paths:
      - node_modules/

test-apps:
  stage: test
  variables:
    CHROME_BIN: google-chrome
  dependencies:
    - install-dependencies
  before_script:
    - apt-get update && apt-get install -y apt-transport-https gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget
    - echo ‘deb http://dl.google.com/linux/chrome/deb/ stable main’ > /etc/apt/sources.list.d/chrome.list
    - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
    - set -x && apt-get update && apt-get install -y xvfb google-chrome-stable
  script:
    - npm run test:ci

karma.config.js

// Karma configuration file, see link for more information
// https://karma-runner.github.io/1.0/config/configuration-file.html
process.env.CHROME_BIN = require('puppeteer').executablePath();

module.exports = function (config) {
  config.set({
    basePath: '',
    frameworks: ['jasmine', '@angular-devkit/build-angular'],
    plugins: [
      require('karma-jasmine'),
      require('karma-chrome-launcher'),
      require('karma-jasmine-html-reporter'),
      require('karma-coverage-istanbul-reporter'),
      require('@angular-devkit/build-angular/plugins/karma')
    ],
    client: {
      clearContext: false // leave Jasmine Spec Runner output visible in browser
    },
    coverageIstanbulReporter: {
      dir: require('path').join(__dirname, './coverage/angular-gitlab-devops-example'),
      reports: ['html', 'lcovonly', 'text-summary'],
      fixWebpackSourcePaths: true
    },
    reporters: ['progress', 'kjhtml'],
    port: 9876,
    colors: true,
    logLevel: config.LOG_INFO,
    autoWatch: true,
    browsers: ['ChromeHeadless'],
    customLaunchers: {
      ChromeHeadlessNoSandbox: {
        base: 'ChromeHeadless',
        flags: ['--no-sandbox']
      }
    },
    singleRun: false,
    restartOnFileChange: true
  });
};

Jorge Sapiains

student•

Muy interesante, pero ¿Cómo configuro un CI en un stack LAMP?

Alejandro Carrasco Rodríguez

student•

me imagino que es con php:7.2-apache https://hub.docker.com/_/php

y prueba intentar migrar los artefactos que se creen en un contenedor de composer https://hub.docker.com/_/composer

Franco Colmenarez

student•

A mí me sale este error: Error: root config contains unknown keys: test-apps

Qué es lo que tengo mal?

image: node:11.1.0
stages:
    - install
    - test

install-dependencies:
    stage: install
    script:
        - npm install
    artifacts:
        expire_in: 1hr
        paths:
            - node_modules/
    cache:
        paths:
            - node_modules/

test-apps:
    stage: test
    variables:
        CHROME_BIN: google-chrome
    dependencies:
        - install-dependencies
    before_script:
        - apt update && apt install -y apt-transport-https
        - wget -q -0 - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key-add -
        - sh -c 'echo "deb https://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
        - apt update && apt install -y google-chrome-stable
        - npm run test:ci

Franco Colmenarez

student•

Ya lo solucioné, me faltaba el script: de abajo y mejorar la indentación

Miguel Alexander Mejía

student•

Un ejemplo para JAVA con gradle, crea stages para pruebas de covertura y mutación además de empaquetar la aplicación springBoot y publicar esa imagen docker en el registry de gitlab.

Usa la imagen docker:latest (para poder construir la imagen) y para los stage necesarios se agrega la imagen de gradle:alpine.

image: docker:latest
services:
  - docker:dind

variables:
  DOCKER_DRIVER: overlay

stages:
  - coverage
  - mutation
  - build
  - package

gradle-build:
  image: gradle:alpine
  stage: build
  variables:
    GRADLE_OPTS: "-Dorg.gradle.daemon=false"

  before_script:
    - export GRADLE_USER_HOME=`pwd`/.gradle
  script:
    gradle bootJar
  artifacts:
    paths:
      - build/libs/*.jar
    expire_in: 1 week

gradle-test:
  image: gradle:alpine
  stage: coverage
  script:
    gradle test jacocoTestCoverageVerification

gradle-mutation:
  image: gradle:alpine
  stage: mutation
  script:
    gradle pitest

docker-build:
  stage: package
  script:
    - docker build -t registry.gitlab.com/msgoon6-scholar/schollar-service .
    - docker login -u msgoon6-********* -p **************** registry.gitlab.com
    - docker push registry.gitlab.com/msgoon6-scholar/schollar-service

Alejandro Velez Patiño

student•

Un ejemplo para Django

image: python:3.6.8
stages:
  - install
  - test

install-dependencies:
  stage: install
  script:
    - pip install virtualenv
    - virtualenv Env
    - source Env/bin/activate
    - pip install -r requirements.txt
  artifacts:
    expire_in: 1hr
    paths:
      - Env
  cache:
    paths:
      - Env

test-apps:
  stage: test
  services:
    - mysql:latest
  dependencies:
    - install-dependencies
  script:
    - source Env/bin/activate
    - python manage.py test

Gonzalo Amador Hernández

student•

Tu pipeline tambien correria sin el stage install, el hentorno local si necesitas el ambiente virtual, pero en produccion no, y en el pipeline tampoco

Gonzalo Amador Hernández

student•

*entorno

Edgar Moises Valdez Faria

student•

Buenas ¿Hay alguna forma de especificar que solo ciertas ramas corran el pipeline?

Gonzalo Amador Hernández

student•

puedes restringir el Job para las ramas que decidas, con la pabra clave only

stages:
  - build

build:
  stage: build
  script:
    - my-scripts
  only:
    - master

Asi solo el Job de build del satege llamado build solo se ejecurara en master