From 61a900501ebe012116165cf6f737fe7bf075eae6 Mon Sep 17 00:00:00 2001 From: Tomas Mirchev Date: Fri, 28 Feb 2025 20:32:40 +0000 Subject: [PATCH] update readme --- README.md | 28 +++++++++++++++++++++++++++- node/README.md | 26 -------------------------- python/README.md | 26 -------------------------- 3 files changed, 27 insertions(+), 53 deletions(-) delete mode 100644 node/README.md delete mode 100644 python/README.md diff --git a/README.md b/README.md index 1482e57..67a233d 100644 --- a/README.md +++ b/README.md @@ -1 +1,27 @@ -# Dev Containers \ No newline at end of file +# Development Containers + +## Authentication +Before updating development images, authenticate to the registry: + +```sh +docker login registry.tomastm.com +``` + +## Updating Development Images +Follow these steps to update development images: + +### Step 1: Update and Commit Changes +- Modify the Dockerfile or install script as needed. +- Ensure that each commit updates only a single development image. +- Commit the changes to version control. + +### Step 2: Build the Image +- Run the following command to build the image: + + ```sh + ./build-image.sh + ``` + +- Since `dockerx` does not function properly inside `qemu`, execute this command separately on machines with different CPU architectures. +- Build the image on both `amd64` and `arm64` architectures. +- Once both architectures are built, the script will automatically generate a manifest. diff --git a/node/README.md b/node/README.md deleted file mode 100644 index aa9df14..0000000 --- a/node/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Dev containers - -## Commands - -Build -``` -docker build \ - --build-arg UID=$(id -u) \ - --build-arg GID=$(id -g) \ - -t web-stack . -``` - -Run. Mount /workspace if you want to preserve changes. Mount /workspace if you want to preserve changes. -``` -podman run -it --rm \ - --userns=keep-id \ - --network host \ - -v $HOME/.ssh:/home/dev/.ssh:ro,Z \ - -v $PWD:/workspace:Z \ - my-dev-container -``` - -## Installed tools -- Common ones: curl, git, vim, tmux, zsh. Included dotfiles. -- NVM and nodejs (lts, v18, v20, v22). -- All package managers preinstalled (npm, pnpm, yarn). Enable with `corepack enable `. diff --git a/python/README.md b/python/README.md deleted file mode 100644 index aa9df14..0000000 --- a/python/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Dev containers - -## Commands - -Build -``` -docker build \ - --build-arg UID=$(id -u) \ - --build-arg GID=$(id -g) \ - -t web-stack . -``` - -Run. Mount /workspace if you want to preserve changes. Mount /workspace if you want to preserve changes. -``` -podman run -it --rm \ - --userns=keep-id \ - --network host \ - -v $HOME/.ssh:/home/dev/.ssh:ro,Z \ - -v $PWD:/workspace:Z \ - my-dev-container -``` - -## Installed tools -- Common ones: curl, git, vim, tmux, zsh. Included dotfiles. -- NVM and nodejs (lts, v18, v20, v22). -- All package managers preinstalled (npm, pnpm, yarn). Enable with `corepack enable `.