Code References: Add GitLab integration guides

Abierto Apto para principiantes
#7,133 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
Medio día
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
gitlab

Línea de trabajo

Abre docs/docs/managing-flags/code-references.md y compara su sección existente de GitHub, incluido el cuadro informativo y los enlaces relacionados. Revisa la plantilla de GitLab a la que hace referencia el issue antes de documentar ambas configuraciones; después, verifica que el ejemplo simple se pueda copiar y pegar, que el job avanzado exponga image, stage y rules, y que esté contemplada la sobrescritura de la URL autoalojada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Context: https://github.com/Flagsmith/flagsmith/issues/7000

The Code References docs page only covers GitHub. We need a GitLab section so a developer can set this up in under five minutes.

Scope

Add an "Integrate with GitLab" section to docs/docs/managing-flags/code-references.md, mirroring the existing GitHub section (simple + advanced). Update the info box (lines 17–21) that says GitHub-only.

Simple configuration

The developer adds two CI/CD variables to their GitLab project and one include to their .gitlab-ci.yml:

include:
  - remote: 'https://raw.githubusercontent.com/Flagsmith/ci/v1.0.0/templates/gitlab-ci.yml'
    inputs:
      flagsmith_project_id: "$FLAGSMITH_PROJECT_ID"

The two variables:

  • FLAGSMITH_PROJECT_ID — from the Flagsmith dashboard URL (/project/<id>/...)
  • FLAGSMITH_CODE_REFERENCES_API_KEY — from Organisation Settings > API Keys, set as masked so it doesn't leak in job logs

Optionally set FLAGSMITH_ADMIN_API_URL for self-hosted Flagsmith instances (defaults to https://api.flagsmith.com).

Advanced configuration

For teams that need to customise the pipeline (different stage, extra rules, multiple repos), show the full job definition that the template abstracts away. Use $CI_PROJECT_URL for repository_url and $CI_COMMIT_SHA for revision, and explain the mapping.

The simple config uses include:remote with inputs: — the advanced config replaces that with an explicit job so the developer can change the image, stage, or rules.

Acceptance criteria
  • Simple config is copy-pasteable with zero code modifications
  • Advanced config shows the full job for customisation
  • Self-hosted Flagsmith URL covered as optional override
  • Links to same related pages as the GitHub section (Admin API Authentication, Flag Lifecycle)
Lenguaje dominante
Python
Estrellas
6.6k
Forks
571
Merge medio
1 d 16 h
PR fusionados (30 d)
116

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Flagsmith/flagsmith

Todos los issues de Flagsmith/flagsmith

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.