Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Generate per-game docker-compose examples from structured game data (e.g. ports)

Abierto
#161 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
docker, json, shell, yaml

Línea de trabajo

Start with generate-dockerfiles.sh and generate-docker-compose.sh, which read serverlist.csv and pass four separate environment variables to the templates. Then check the default port values in lgsm/config-default/config-lgsm/<shortname>server/_default.cfg and the publish workflow's matrix. Done means each game gets one structured record that reaches the templates as game.*, with its default ports in the compose output, and the matrix and image names stay unchanged. Reading PR #103 first is worthwhile, since it covers part of this design.

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

Descripción

enhancement

Idea

Generate each game's docker-compose example (and Dockerfile, where useful) from richer per-game data, so the examples are correct for that game out of the box. For example, publish the game's default ports rather than a generic example.

Today

generate-dockerfiles.sh and generate-docker-compose.sh read LinuxGSM's serverlist.csv, which has only four fields per game: shortname, server name, game name and distro. The templates get those as separate environment variables, so there is nothing game-specific to put in the compose examples beyond the name and image tag.

Possible approach

  • Build one structured record per game (for example JSON). Start with the four serverlist.csv fields, and add data read from LinuxGSM, such as default ports from lgsm/config-default/config-lgsm/<shortname>server/_default.cfg.
  • Pass each game's record to the Jinja templates as one object (game.shortname, game.ports, and so on).
  • Keep the publish workflow's matrix as a list ({"include":[{"shortname":"..."}]}), the dockerfiles/Dockerfile-<shortname> names, and the ghcr.io base image.

Background

#103 (B13rg, 2024) started the refactor towards per-game JSON records but stopped before adding any new data, and it no longer fits the current generator and workflow. Its JSON conversion with yq and its game.* template variables are a useful starting point.

Lenguaje dominante
Shell
Estrellas
345
Forks
25
Merge medio
12 h 12 min
PR fusionados (30 d)
9

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin 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 GameServerManagers/docker-gameserver

Todos los issues de GameServerManagers/docker-gameserver

Issues similares

Más issues de Shell/Bash

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.