docs: add the cleanup to the flow

bjarneo · Nov 30, 2024 · b424ba0 · b424ba0
1 parent 118b38a
commit b424ba0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/FLOW.md b/FLOW.md
@@ -27,7 +27,8 @@ flowchart TD
         RemoveContainer --> StartContainer[Start New Container]
         StartContainer --> VerifyContainer{Verify Container Status}
         
-        VerifyContainer --> |"Up"| Success([Deployment Success])
+        VerifyContainer --> |"Up"| CleanupImages[Cleanup Old Images]
+        CleanupImages --> |"Keep Latest 5"| Success([Deployment Success])
         VerifyContainer --> |"Down"| Failure([Deployment Failure])
     end
     

diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ https://github.com/user-attachments/assets/68111156-4445-43c1-9d63-071b2680abc3
 - Docker installed locally and on the remote host
 - SSH access to the remote host
 - SSH key-based authentication
+- Go 1.21 or higher (due to usage of slices.Reverse)
 
 ## Installation
 
@@ -52,7 +53,7 @@ Alternatively, you can build from source:
 
 Requirements:
 
-- Go 1.x or higher
+- Go 1.21 or higher
 
 ```bash
 git clone <repository-url>
@@ -268,6 +269,7 @@ When using Pipe as a GitHub Action, the following inputs are available:
 6. Stops and removes existing container
 7. Starts new container with specified configuration
 8. Verifies container is running properly
+9. Automatically cleans up old releases (keeps only the latest 5 images)
 
 Flow chart: FLOW.md