Merge pull request #5 from manghidev/develop

Implementing versioning file for the project

Author: manghidev

.dotfiles/.config/nvim/lazy-lock.json

@@ -22,9 +22,9 @@
   "mini.icons": { "branch": "main", "commit": "397ed3807e96b59709ef3292f0a3e253d5c1dc0a" },
   "mini.pairs": { "branch": "main", "commit": "69864a2efb36c030877421634487fd90db1e4298" },
   "noice.nvim": { "branch": "main", "commit": "0427460c2d7f673ad60eb02b35f5e9926cf67c59" },
-  "nui.nvim": { "branch": "main", "commit": "8d5b0b568517935d3c84f257f272ef004d9f5a59" },
+  "nui.nvim": { "branch": "main", "commit": "f535005e6ad1016383f24e39559833759453564e" },
   "nvim-lint": { "branch": "master", "commit": "9dfb77ef6c5092a19502883c02dc5a02ec648729" },
-  "nvim-lspconfig": { "branch": "master", "commit": "46434074f188e6bfccf9d9153dd8be6b1381498b" },
+  "nvim-lspconfig": { "branch": "master", "commit": "1b801f68d09e70e59e6dd967b663b6d84ee3e87d" },
   "nvim-treesitter": { "branch": "master", "commit": "94ea4f436d2b59c80f02e293466c374584f03b8c" },
   "nvim-treesitter-textobjects": { "branch": "master", "commit": "ed373482db797bbf71bdff37a15c7555a84dce47" },
   "nvim-ts-autotag": { "branch": "main", "commit": "a1d526af391f6aebb25a8795cbc05351ed3620b5" },

Dockerfile

@@ -1,10 +1,12 @@
 #* Set the base image to Node.js LTS on Alpine
 FROM node:lts-alpine
 
+ARG VERSION
+
 #* Set metadata for image
 LABEL maintainer="ManghiDev <https://manghi.dev>" \
     description="Dockerfile for LazyVim and Zsh with oh-my-zsh" \
-    version="1.0.0"
+    version=$VERSION
 
 #* Install necessary dependencies
 RUN apk add --no-cache git lazygit fzf curl neovim ripgrep alpine-sdk zsh shadow

README.md

@@ -8,13 +8,38 @@ This project provides a Dockerized environment to use LazyVim, an advanced Neovi
 
 - **LazyVim**: Predefined Neovim configuration to maximize productivity.
 - **Dockerized**: Fully isolated and reproducible environment.
-- **Zsh with Oh My Zsh**: Interactive shell with plugins and advanced customization.
+- **bash with Oh My bash**: Interactive shell with plugins and advanced customization.
 - **Included tools**: `git`, `lazygit`, `fzf`, `ripgrep`, among others.
 - **Volume mounting**: Direct access to your local files from the container.
 - **Persistent configuration**: Configuration changes are retained between sessions.
 
 ---
 
+## Versioning
+
+This project uses a global version stored in the `VERSION` file located in the root of the repository. The version is used during the Docker image build process and is embedded as metadata in the image.
+
+### How to Update the Version
+
+1. Open the `VERSION` file in the root of the project.
+2. Update the version number (e.g., change `1.1.0` to `1.2.0`).
+3. Rebuild the Docker image using the `build.sh` script:
+```bash
+./build.sh
+   ```
+
+### Checking the Version in the Docker Image
+
+After building the image, you can verify the version embedded in the image by running:
+
+```bash
+docker inspect <image_name> | grep '"version"'
+```
+
+Replace `<image_name>` with the name of your Docker image.
+
+---
+
 ## Requirements
 
 - **Docker**: Make sure Docker is installed on your system.
@@ -46,26 +71,34 @@ chmod +x ./build.sh
 
 ## Installation
 
+### Automatic Installation
+If you want to automate the installation process, run the following command. This will clone the repository, navigate to the project folder, grant execution permissions to the scripts, and build the environment:
+
+```bash
+git clone https://github.com/manghidev/lazyvim-docker.git && cd lazyvim-docker && chmod +x ./build.sh ./init.sh ./destroy.sh && ./build.sh
+```
+
+### Manual Installation
 1. Clone this repository:
-   ```bash
-   git clone https://github.com/manghidev/lazyvim-docker.git
-   cd lazyvim-docker
-   ```
+```bash
+git clone https://github.com/manghidev/lazyvim-docker.git
+cd lazyvim-docker
+```
 
-2. Build the environment using the `build.sh` script:
-   ```bash
-   ./build.sh
-   ```
+2. Build the environment using the `build.sh` script (Only the first time, or when you want to update the image, as it will erase everything and rebuild everything):
+```bash
+./build.sh
+```
 
-3. If you need to re-enter the container, use the `init.sh` script:
-   ```bash
-   ./init.sh
-   ```
+3. If you need to re-enter or run the container again, use the `init.sh` script:
+```bash
+./init.sh
+```
 
-4. To destroy the environment (without deleting the volumes), use the `destroy.sh` script:
-   ```bash
-   ./destroy.sh
-   ```
+4. To destroy the environment (along with the volumes), use the `destroy.sh` script:
+```bash
+./destroy.sh
+```
 
 ---
 
@@ -131,4 +164,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
 
 ## Author
 
-Created by ManghiDev. For more information, visit [manghi.dev](https://manghi.dev).
+Created by ManghiDev. For more information, visit [https://manghi.dev](https://manghi.dev).

VERSION

@@ -0,0 +1 @@
+1.1.0

build.sh

@@ -1,11 +1,13 @@
+VERSION=$(cat VERSION)
+
 echo "Cleaning up the environment"
 docker compose down --rmi all
 
 echo "Pulling the latest images"
 docker compose pull
 
-echo "Rebuilding the container"
-docker compose build --no-cache
+echo "Building the container with this version $VERSION"
+docker compose build --build-arg VERSION=$VERSION --no-cache
 
 echo "Starting the container"
 docker compose up --force-recreate -d

destroy.sh

@@ -1,4 +1,5 @@
 # Stop and remove the container
-docker compose down --rmi all
+# Stop and remove the container along with volumes
+docker compose down --rmi all --volumes
 
-echo "Container stopped and removed"
+echo "Container and volumes stopped and removed"

docker-compose.yml

@@ -3,6 +3,8 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
+      args:
+        VERSION: ${VERSION:-1.0.0}
     container_name: lazyvim
     volumes:
       - .dotfiles/.zshrc:/home/developer/.zshrc

init.sh

@@ -1,2 +1,5 @@
+echo "Starting the container"
+docker compose up -d
+
 echo "Enter to the lazyvim container"
 docker exec -it lazyvim zsh