CHANGELOG.md

v0.34.0 (2024-12-28)

Bug Fixes

• Correct command in copier.yaml to properly add Git submodule (b33cf17)

• Correct conditional syntax for HOST_SOURCE_DIR variable in docker.common.env.jinja (8c6633e)

• Correct variable references in copier.yaml for single GitHub repository support (36f5a2a)

• Update app_dirname to hyperfast-docker-template and adjust environment variable defaults in configuration files (cff5739)

• Update APP_REPO_NAME and HOST_SOURCE_DIR variable definitions for improved conditional handling (483ac30)

• Update git submodule command in copier.yaml to improve error handling and output (af245c2)

• Update source directory and GitHub repository configurations in Copier templates for consistency (6910b4e)

• Update volume mappings in docker-compose template for improved directory configuration (329d45f)

• deps: Update python-semantic-release and docker actions to latest versions (05eecb6)

• deps: Update python-semantic-release to version 9.15.2 (274d78a)

• docker: Update application directory name and configuration paths (258d062)

• docker: Update application directory name and dependencies in configuration files (702d917)

Chores

• Update Copier version and add source directory configuration in .copier-docker-config.yaml (3ba3562)

• deps: Bump docker/build-push-action from 6.9.0 to 6.10.0 (#261, 842a722)

Bumps docker/build-push-action from 6.9.0 to 6.10.0.

• Release notes - Commits

--- updated-dependencies: - dependency-name: docker/build-push-action dependency-type: direct:production

update-type: version-update:semver-minor

...

Signed-off-by: dependabot[bot] support@github.com

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

• deps: Bump docker/metadata-action from 5.5.1 to 5.6.1 (#260, dba1031)

Bumps docker/metadata-action from 5.5.1 to 5.6.1. - Release notes - Commits

--- updated-dependencies: - dependency-name: docker/metadata-action dependency-type: direct:production

update-type: version-update:semver-minor

...

Signed-off-by: dependabot[bot] support@github.com

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

• deps: Bump python-semantic-release/python-semantic-release (210d7f8)

Bumps python-semantic-release/python-semantic-release from 9.12.1 to 9.12.2. - Release notes - Changelog

Commits

--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production

update-type: version-update:semver-patch

...

Signed-off-by: dependabot[bot] support@github.com

• deps: Bump python-semantic-release/python-semantic-release (b6e4f1c)

Bumps python-semantic-release/python-semantic-release from 9.12.0 to 9.12.1. - Release notes - Changelog

Commits

--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production

update-type: version-update:semver-patch

...

Signed-off-by: dependabot[bot] support@github.com

• deps: Bump python-semantic-release/python-semantic-release (#258, d54f2af)

Bumps python-semantic-release/python-semantic-release from 9.12.2 to 9.13.0. - Release notes - Changelog

Commits

--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production

update-type: version-update:semver-minor

...

Signed-off-by: dependabot[bot] support@github.com

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

• deps: Bump python-semantic-release/python-semantic-release (#259, 937bcd2)

• deps: Bump python-semantic-release/python-semantic-release (#262, b2b9a4a)

• deps: Bump python-semantic-release/python-semantic-release (#263, 56a28ff)

Bumps python-semantic-release/python-semantic-release from 9.15.0 to 9.15.1. - Release notes - Changelog

Commits

--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production

update-type: version-update:semver-patch

...

Signed-off-by: dependabot[bot] support@github.com

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

• deps: Bump python-semantic-release/python-semantic-release (#264, c7941eb)

Bumps python-semantic-release/python-semantic-release from 9.15.1 to 9.15.2. - Release notes - Changelog

Commits

--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production

update-type: version-update:semver-patch

...

Signed-off-by: dependabot[bot] support@github.com

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Features

• Add APP_REPO_NAME and HOST_SOURCE_DIR variables to docker.common.env.jinja for improved configuration (a25e3a0)

• Add copier submodule for project management (b9049be)

• Add support for adding multiple GitHub submodules in copier.yaml (90d1c71)

• Add support for multiple GitHub repositories and configurable source directory path in copier.yaml (5173533)

• Enhance issue template to support multiple GitHub repositories and modernize copier.yaml for compatibility (ea1a6df)

• Update copier.yaml to support a single GitHub repository as a submodule (5c174dd)

v0.33.0 (2024-10-28)

Chores

• chore: Remove unused .github/workflows/release.yaml file (b1f2555)

• chore: Remove unused .github/workflows/prerelease.yaml file (e8f4bed)

Features

• feat: Update python-semantic-release version to 9.12.0 and remove unused .github/workflows/prerelease.yaml file (f26e8e9)

• feat: Update python-semantic-release version to 9.12.0 (4669038)

Unknown

• Merge pull request #252 from entelecheia/entelecheia/issue251 (279ed07)

• Merge pull request #248 from entelecheia/release

Release (8e724c4)

v0.32.0 (2024-10-15)

Feature

• docker: Add support for restart policy and TTY options (3d41a1f)

v0.31.5 (2024-09-30)

Fix

• workflows: Upgrade docker/build-push-action to v6.9.0 (53d798e)

v0.31.4 (2024-08-17)

Fix

• Update docker/build-push-action to v6.7.0 (0a39e21)

v0.31.3 (2024-08-10)

Fix

• Update docker/build-push-action to v6.6.1 (ba1a7d7)

v0.31.2 (2024-07-22)

Fix

• Update docker/build-push-action to v6.5.0 (fe67a3a)

v0.31.1 (2024-07-17)

Fix

• Update docker/build-push-action to v6.4.1 (2fdf8ef)

v0.31.0 (2024-07-04)

Feature

• docker: Add support for tty configuration in Docker containers (f23dad5)

Fix

• docker: Add message before starting Jupyter Lab (528bcb8)
• workflows: Upgrade docker/build-push-action to 63.0 (81e6bf5)
• docker: Correct typo in tty Jinja2 template variable (b908113)

v0.30.6 (2024-06-23)

Fix

• Update docker/build-push-action to version 6.1.0 (aaa1b41)

v0.30.5 (2024-06-23)

Fix

• Update docker/build-push-action to version 6.0.2 (f1165f2)

v0.30.4 (2024-06-11)

Fix

• Update docker/build-push-action to version 5.4.0 (c881a6a)

v0.30.3 (2024-05-28)

Fix

• Update docker/login-action to version 3.2.0 (e4fc125)

v0.30.2 (2024-05-10)

Fix

• docker: Update docker-compose files (4de6aaf)

v0.30.1 (2024-05-04)

Fix

• base: Update base image to library/ubuntu:24.04 (4c93005)

v0.30.0 (2024-04-10)

Feature

• docker: Add entrypoint.sh.jinja script with UID GID updates (9eda9ef)

Fix

• docker: Add support for custom container network name (b90f93f)

v0.29.10 (2024-04-05)

Fix

• usermod: Remove usermod group id modification and update user id (c20407f)
• docker: Update usermod command to only update UID; fix missing group option (18f042d)

v0.29.9 (2024-04-05)

Fix

• workflows: Update deploy-{{ docker_image_name }}-image.yaml; .docker/docker.version file and updated paths for docker image variant files (7a3aafd)

v0.29.8 (2024-04-05)

Fix

• workflow: Update path pattern in deploy yaml template (46edaa6)

v0.29.7 (2024-04-05)

Fix

• base: Add software-properties-common to Dockerfile base image installation (c66ac2a)
• docker: Add software-properties-common to installed packages in Dockerfile.jinja (c49c1cf)

v0.29.6 (2024-04-05)

Fix

• deployment: Update paths for Docker image variants (02edfff)

v0.29.5 (2024-04-04)

Fix

• dockerfile: Improve user id handling and chown commands (d2dc310)
• deploy: Added latest tag for docker image (7c35c83)

v0.29.4 (2024-04-04)

Fix

• docker.common.env: Update CONTAINER_USERNAME variable assignment (72d854a)
• env: Update container username assignment; as the container username was being assigned incorrectly, this commit fixes it by correctly assigning the container username variable. (2a1d81d)

v0.29.3 (2024-04-04)

Fix

• docker: Fix condition for copying apt packages (3aa39bf)
• doc: Update README.md.jinja for Docker image naming (9cdf3b1)

v0.29.2 (2024-04-04)

Fix

• actions/checkout: Update actions/checkout version to v4 (b557030)
• docker: Update installation of docker apt packages (26bae9f)

v0.29.1 (2024-04-04)

Fix

• workflows: Update Dockerfile build path (11b438a)

v0.29.0 (2024-04-04)

Feature

• docker: Add docker-compose base configuration files and scripts (488668e)
• docker: Update docker-compose script to include the name variable (e1c438b)

v0.28.7 (2024-03-16)

Fix

• docker: Upgrade build-push-action version to v5.3.0 (2292ed9)

v0.28.6 (2024-03-13)

Fix

• workflows: Update docker login-action to v3.1.0 (64769a2)

v0.28.5 (2024-03-10)

Fix

• workflow: Upgrade docker/build-push-action to v5.2.0 (b69d701)

v0.28.4 (2024-01-31)

Fix

• dependencies: Upgrade docker/metadata-action from v5.5.0 to v5.5.1 (5892091)

v0.28.3 (2024-01-13)

Fix

• dependencies: Upgrade docker/metadata-action to v5.5.0 (66300b6)
• workflows: Upgrade docker/metadata-action to v5.5.0 (3930f81)

v0.28.2 (2023-12-19)

Fix

• actions: Update docker/metadata-action to v5.4.0 (fcf2a49)

v0.28.1 (2023-12-04)

Fix

• github-workflows: Upgrade docker/metadata-action to v5.3.0 (ebd18da)

v0.28.0 (2023-11-12)

Feature

• docker: Add docker app image variant environment variables (8abf461)
• docker: Add specific pid naming to docker variant commands (7d97c54)

v0.27.0 (2023-10-30)

Feature

• docker-config: Add docker image version variable (41e3962)
• docker: Update image version variable name in docker.common.env.jinja (f78de66)
• copier.yaml: Add image versioning variables (62d9195)
• .docker: Add docker.version.jinja file (5aa2af7)

v0.26.0 (2023-10-21)

Feature

• dockerfile: Add user permissions update (c47ccd8)
• docker: Add default.env.jinja configuration file (550de10)
• docker-compose.sh.jinja: Add project ID option, add project ID specific environment variable loading, add local workspace preparation (b327653)
• docker: Add configurable directories and project ID support (f267e80)
• github-actions: Adjust workflows for docker branch (bd9b659)

v0.25.1 (2023-10-20)

Fix

• docker: Update build from image convention (2f7823f)

v0.25.0 (2023-10-13)

Feature

• docker: Upgrade pip, setuptools, wheel, ninja in Dockerfile.base (fd5b4ab)

v0.24.1 (2023-10-11)

Fix

• .github/workflows: Update Dockerfile and docker-compose file paths in release.yaml (4f24f3c)

v0.24.0 (2023-10-10)

Feature

• docker-compose: Add HF_HOME mapping to volumes (bf597e1)
• system-settings: Allow customization of SSH public key and HuggingFace home path (4c9ce3c)
• docker: Add variables if dotfiles installed (6b5c87d)
• docker-compose: Add conditions for dotfiles installation (2eb04ef)

Fix

• docker-scripts: Replace clone with ssh setup and modify jupyter command (721b04e)

v0.23.5 (2023-10-09)

Fix

• docker: Remove symbolic links for Python and pip (3cbdc18)

v0.23.4 (2023-10-09)

Fix

• dockerfile: Change python command syntax (f1e17ab)

v0.23.3 (2023-10-09)

Fix

• docker: Use variable for python command (def6678)

v0.23.2 (2023-10-09)

Fix

• docker: Update ENVs and ARGs in Dockerfile.base (59de4a8)

v0.23.1 (2023-10-09)

Fix

• docker: Remove redundant chown command (ff0f2b4)

v0.23.0 (2023-10-09)

Feature

• docker: Add builder stage to Dockerfile, add python-virtual-environment creation, add support for runtime image stage (2777efe)
• copier.yaml: Add variables for app installation root, directory name, clone source code, and source repository (f258bdc)

v0.22.1 (2023-10-08)

Fix

• docker: Add user permissions fix-up in container startup script (d1bb50b)

v0.22.0 (2023-10-02)

Feature

• docker-scripts: Load and print environment variables (fa3935c)
• .docker: Add printing of loaded environment variables (509bafa)

v0.21.0 (2023-10-02)

Feature

• scripts: Add free disk space script in .github folder (dcbdc6f)
• .github/workflows: Add disk space securing script before build (5224a92)

v0.20.1 (2023-10-02)

Fix

• docker: Remove sudo from pip install command in dockerfile.base (25c23db)
• docker: Remove sudo from pip install command (29d1e36)

v0.20.0 (2023-10-01)

Feature

• Makefile: Add symlink for global docker env file for local development (d25159c)
• Makefile.jinja: Add symlink global docker env function (f25a88e)

v0.19.0 (2023-10-01)

Feature

• copier: Add python version option (ba0ea05)

Fix

• dockerfile: Support dynamic python version (8e209d8)

v0.18.0 (2023-10-01)

Feature

• docker: Add requirements-base pip installation in Dockerfile (5ce007f)

v0.17.0 (2023-08-31)

Feature

• docker-scripts: Add detached mode for launching docker app image (e4959c5)
• copier.yaml: Add docker_name_prefix configuration (efdf17e)
• docker: Enhance environment variables loading (50d33b0)

Fix

• github-actions: Use correct syntax for GitHub Actions variables (cdfc363)
• docker: Correct typo in CONTAINER_REGISTRY variable name (09db2b4)

v0.16.1 (2023-08-30)

Fix

• docker: Add python environment variables and set timezone in Dockerfile.app (610e245)

v0.16.0 (2023-08-30)

Feature

• docker: Add Python local bin to PATH (b978e4c)

v0.15.3 (2023-08-30)

Fix

• docker: Update pip installation in Dockerfile.base (3492bca)
• dockerfile: Update pip installation in Dockerfile base template (513ffb4)

v0.15.2 (2023-08-30)

Fix

• docker: Improve environment variable loading and network preparation checks (9975d50)

v0.15.1 (2023-08-29)

Fix

• dockerfile: Correct duplication in 'get-pip.py' download command (8565f7e)

v0.15.0 (2023-08-29)

Feature

• docker: Add option to install latest pip and setuptools (76695b4)

v0.14.3 (2023-08-29)

Fix

• workflows: Change APP_VERSION to IMAGE_VERSION in deploy-base-image.yaml (8a836e2)

v0.14.2 (2023-08-29)

Fix

• github-actions: Rename variable names for container user details (ba1d3f8)
• deploy-scripts: Update environment variable names (4ffbd47)

v0.14.1 (2023-08-29)

Fix

• workflows: Add common environment variables from dotenv (c1a8982)

v0.14.0 (2023-08-29)

Feature

• README: Add description for different environment variables files (c2fdc7a)
• docker: Add sync host folder group permissions to container (78f5736)
• docker: Add Docker group ID to environment variables (977aa13)
• docker-compose: Add DOCKER_GID environment variable (b518a17)
• docker-config: Update variables and arrangement (3dd22fa)
• docker: Add common env variables for docker configuration (238ce12)
• copier.yaml: Add docker_service_name field (b603672)

v0.13.0 (2023-08-29)

Feature

• docker-config: Enable building images from Dockerfile (0cfcfc7)
• docker: Add build images from Dockerfile option (9d38c0c)

v0.12.0 (2023-08-27)

Feature

• docker-scripts: Load secret environment variables from .env.secret (771e368)
• .copier-template: Add .env.secret file (e128d6f)

v0.11.1 (2023-08-24)

Fix

• readme: Replace hardcoded port values with template variables (c88db9d)
• copier: Add main branch configuration (98b59de)

v0.11.0 (2023-08-23)

Feature

• .github/workflows: Add success check for workflow run (ce8e16d)

Fix

• workflows: Allow manual dispatch for deploy-app-image workflow (a272115)
• docker: Switch from pip to pip3 in Dockerfile.base.jinja (fa70f04)

v0.10.0 (2023-08-23)

Feature

• copier.yaml: Reorganize docker related configurations and add deploy workflows option (2518dc8)

Fix

• github-workflows: Rename deploy-app-image and deploy-base-image files with conditional inclusion (45d791a)

v0.9.0 (2023-08-23)

Feature

• .github/workflows: Add new semantic-release workflow (119b96c)

v0.8.0 (2023-08-23)

Feature

• docker-config: Add new ports and tokens (1f35d2b)
• docker-compose: Add workspace location and system hostname arguments (6514a56)
• copier.yaml: Add ssh_port, jupyter_port, jupyter_token, web_service_port and web_service_host_port configurations (e50f184)

v0.7.2 (2023-08-22)

Fix

• Makefile.jinja: Change test-initialize directory to tmp (77b2b48)

Documentation

• README: Update setup instructions and environment variable info (2ea6175)
• .copier-template: Add detailed README.md.jinja template (816b4ec)

v0.7.1 (2023-08-22)

Fix

• docker: Simplify Docker image naming (0354dfb)
• docker: Modify IMAGE_NAME in docker base env file (caa0d2e)
• .github/workflows: Change VARIANT to BASE_VARIANT in deploy-base-image workflow (e999414)

v0.7.0 (2023-08-22)

Feature

• docker: Add user email, full name and GitHub username, update clone directory name, add Jupyter port and token configuration (3b260c3)
• docker: Add commands to run and launch app and base images (5a628be)
• Makefile: Add force and test initialization commands (9f7d9fa)
• .copier-config: Update config values and add new configs (716434a)
• docker-compose: Allow specification of image tags (93c10e3)
• docker-compose: Add new environment variables and volume mappings (5a1eb60)
• docker: Add logic to clone repo and start jupyter lab (8500480)

Fix

• dockerfile: Change installation order and condition for openssh-server (5ec40d2)
• template: Replace project_name with docker_project_name (0fd36e9)
• copier.yaml: Update variable names and default value messages (26832cb)
• copier-template: Rename .copier-config.yaml to .copier-docker-config (555a384)
• docker: Change variable docker_registry to docker_project_name (c76f859)

v0.6.2 (2023-08-21)

Fix

• docker: Remove APP_VERSION from docker.app.env (6a5bd11)
• project: Rename Makefile to Makefile.jinja (c94bd52)

v0.6.1 (2023-08-21)

Fix

• docker: Update base image for Docker build (e6b5726)

v0.6.0 (2023-08-21)

Feature

• docker-scripts: Add login command to docker-compose script (2d750e3)
• docker: Add USERNAME environment variable (4816f1b)
• copier.yaml: Add CUDA device config (b48f0d5)
• docker: Add ipc mode and run command variables to docker config (2446ae0)
• license: Add License templates (dd3f50a)
• license: Add CC-BY-4.0 license (4797420)
• license: Add Apache-2.0 license template (87cbad0)
• copier.yaml: Add author and email fields with validation (f087b99)
• contributing: Add contributing guide (6253d18)
• copier-template: Add Code of Conduct template (d2b11c2)
• poe: Add tasks for versioning and changelog generation (d5bf1cb)
• .copier-template: Add CHANGELOG.md file (6327263)
• copier-template: Add new pyproject.toml.jinja file (bf30d21)
• .copier-template: Add .gitattributes file (22e6488)
• .editorconfig: Add new file with configuration settings (6abc735)
• .copier-template: Add .copierignore file (a6a0a6d)

v0.5.0 (2023-08-21)

Feature

• copier.yaml: Add new fields for source repository cloning (1013717)
• docker: Add conditional execution for starting ssh service, add cloning app repository from Github, add starting Jupyter notebook in background (d332aa9)
• dockerfile: Clone source code based on clone_source_code value (442c18d)
• copier.yaml: Add NVIDIA GPU enable option (5701513)
• docker: Enable pip installation of python dependencies (0f12dea)
• Dockerfile: Add command customization via template variable (d9649d8)
• copier.yaml: Add project_license selection (67a0193)
• github-actions: Add workflows for deploying app and base images (1ff6d3f)
• Makefile: Add Docker-related commands (a744019)

v0.4.3 (2023-08-21)

Fix

• .github/workflows: Update triggers and tags in deployment workflows (81419c5)

v0.4.2 (2023-08-21)

Fix

• github-workflows: Update tags trigger for app and base image deployments (ce5c741)

v0.4.1 (2023-08-21)

Fix

• release: Remove skip ci from commit subject (83c1c7a)

v0.4.0 (2023-08-21)

Feature

• Makefile: Add docker-login command (08fe3a7)

v0.3.0 (2023-08-21)

Feature

• docker: Add container registry (a87d022)
• docker: Add new docker-compose script (5ef6e90)
• .github: Add deploy-app-image workflow (91e1e78)
• docker-compose.base: Add new ARGs to docker (d3eca6f)

v0.2.0 (2023-08-21)

Feature

• .github/workflows: Support main branch in deploy-base-image workflow (e73279c)
• docker: Add tags to docker-compose.base.yaml (1901f43)
• .github/workflows: Add dotenv action to docker deployment workflow (de8a929)
• docker: Add docker.release.env configuration file (815d977)
• .github/workflows: Add dynamic tagging in deploy-image.yaml (147d6a0)
• Docker: Add python3-launchpadlib to installs (bc3d0d6)
• docker: Update Dockerfile labels and fix apt-get update (9b6020f)
• .github/workflows: Add docker image deployment script (33d8ab2)
• docker: Add docker login script (2b6369e)
• docker: Add new docker configuration script (6da71d3)
• docker: Add commands in docker-build.sh (3541852)
• docker: Initialize base docker-compose configuration (5238eaa)
• docker: Add new docker configurations (797701a)
• docker: Add new Dockerfile.base and associated scripts (a273478)
• docker: Add docker.version with APP_VERSION field (03ec0b5)
• .tasks-docker.toml: Add a new file (8491ac5)

v0.1.2 (2023-05-18)

Fix

• docker): update Dockerfile and docker-compose files for app; chore(docker: Add docker-build and docker-config rules; (5b5a31e)

v0.1.1 (2023-05-18)

Fix

• app: Change APP_INSTALL_ROOT to APP_PROJECT_ROOT (2909664)

v0.1.0 (2023-05-18)

Feature

• Initial version (daa5516)