Add a Dockerfile and publish a Docker image of the starter project on Docker Hub

Aberta
#215 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
docker, docker-compose, github-actions, php

Direção de pesquisa

First resolve the listed decisions about the Docker Hub namespace, PHP versions, image type, and database; the work is also gated on the project requiring PHP 8.2. Read the README and project setup requirements, then add the Dockerfile, .dockerignore, docker-compose.yml, and .github/workflows/docker.yml described in the issue. Verify that docker compose up serves the home page and php qt install:demo runs, then confirm the release workflow publishes version and latest tags without baking in secrets.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

feature

Summary

Let users run a new Quantum project with Docker, and publish an image of it on Docker Hub with every release. The repository has no Docker files today. This is planned for 3.2.0, which raises the minimum PHP version to 8.2, so the image starts from PHP 8.2.

Why

Starting a Quantum project needs PHP 8.2 or newer (the minimum of 3.2.0), Composer and several extensions (pdo, curl, json, simplexml, fileinfo, openssl, bcmath, plus dom and zip for some features). An image gives a working setup in one command, on any machine, without installing PHP.

Scope

Files to add to this repository:

  • Dockerfile: PHP 8.2 on Apache, the extensions above, Composer, the document root set to public/, mod_rewrite on, and write access to logs/, cache/ and runtime/. The .env is read at run time, and no secret is stored in the image.
  • .dockerignore.
  • docker-compose.yml: the app, a database, and Redis as an option.
  • .github/workflows/docker.yml: build and push the image to Docker Hub when a release tag is published, for amd64 and arm64.
  • A short section in README.md on how to run it.

Two kinds of image are possible: a runtime image where the project is mounted or created with composer create-project quantum/project, and a ready image that already contains a created project and starts a working app. The first one comes first; the second is a thin layer on top of it.

To decide before the work starts

  • the Docker Hub namespace and repository, and who owns them
  • the PHP versions to publish, from 8.2 up
  • which kind of image comes first
  • which database the compose file starts with

The access token and the account name are stored as the repository secrets DOCKERHUB_TOKEN and DOCKERHUB_USERNAME by the maintainer.

Order

The work starts after the project requires PHP 8.2 (3.2.0), because the image must run the version the project supports.

Out of scope

  • Changes to the framework repository.
  • Tags and releases: they are cut by the maintainer, and the workflow only reacts to a published tag.

Acceptance criteria

  • docker compose up starts the project, and the home page answers
  • the image runs php qt commands, including install:demo
  • no secret is baked into the image
  • a published release tag pushes the image to Docker Hub with the version tag and latest
  • the README explains how to run it
Linguagem predominante
PHP
Estrelas
49
Forks
20
Merge médio
16min
PRs com merge (30d)
9

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de quantum-php/project

Todas as issues de quantum-php/project

Issues semelhantes

Mais issues de PHP

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.