Skip to content

docs: add notes on GH images #1475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ilyamandel merged 1 commit into from
Apr 18, 2026
Merged

docs: add notes on GH images #1475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions online-docs/pages/Developer guide/Developer build/docker-developer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,29 @@ Creating a Docker image
=======================


Overview
--------

Docker simplifies COMPAS deployment by containerizing all dependencies and build tools,
eliminating manual environment configuration across different operating systems and platforms.
This enables reliable deployment on cloud platforms and consistent development environments.

For information on how to use Docker to run COMPAS, see the :doc:`../../User guide/docker` page.


GitHub CI/CD
------------

``Docker`` images of all versions of COMPAS (``dev`` branch) are available at the
`TeamCOMPAS dockerHub page <https://hub.docker.com/u/teamcompas>`__. Building of these images is performed automatically by the
``GitHub`` CI/CD process.
``Docker`` images of all versions of COMPAS (``dev`` branch) are available at:

- `TeamCOMPAS dockerHub page <https://hub.docker.com/u/teamcompas>`__
- `GitHub Container Registry <https://github.com/TeamCOMPAS/COMPAS/pkgs/container/compas>`__

Building of these images is performed automatically by the ``GitHub`` CI/CD process.

Whenever a push to `TeamCOMPAS/dev <https://github.com/TeamCOMPAS/COMPAS/tree/dev>`__ occurs, a continuous deployment process
automatically
builds\ [#f1]_ a new image and deploys it to ``dockerHub`` with a `tag`\ [#f2]_ that corresponds to the value of ``VERSION_STRING``
builds\ [#f1]_ a new image and deploys it to both ``dockerHub`` and the ``GitHub Container Registry`` with a `tag`\ [#f2]_ that corresponds to the value of ``VERSION_STRING``
in ``changelog.h`` (see :doc:`../changelog` for detailed information regarding ``changelog.h``).

At time of writing, `GitHub Actions`\ [#f3]_ facilitates the above process. While this is convenient (because it's free and well
Expand All @@ -24,6 +37,25 @@ See the `Atlassian CI/CD <https://www.atlassian.com/continuous-delivery/principl
documentation for detailed information regarding the ``GitHub`` CI/CD process.


Using GitHub Container Images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``GitHub Container Registry`` makes COMPAS images available without requiring a dockerHub account. You can use the GitHub image in the same way as a dockerHub image:

.. code-block:: bash

# Pull the latest development image
docker pull ghcr.io/teamcompas/compas:latest

# Pull a specific version
docker pull ghcr.io/teamcompas/compas:v02.43.01

# Run a container
docker run -it ghcr.io/teamcompas/compas:latest /bin/bash

For more information, see the `GitHub Container Registry <https://github.com/TeamCOMPAS/COMPAS/pkgs/container/compas>`__.


Dockerfile
----------

Expand Down
Loading