Merge pull request #9 from actalog/v2

V2

.github/workflows/release.yml → .github/workflows/cd.yml

@@ -1,9 +1,9 @@
-name: Release
+name: CD
 
 on:
   push:
     tags:
-      - v[0-9]+.[0-9]+.[0-9]+
+      - v*
 
 permissions:
   contents: write

.github/workflows/ci.yml

@@ -25,6 +25,7 @@ jobs:
       - uses: ./
         with:
           connection-string: mongodb://root:root@database:27017
+          output-password: '12345678'
       - uses: actions/upload-artifact@v4
         with:
           name: dump-mongo${{ matrix.mongo-version }}

README.md

@@ -1,29 +1,56 @@
 # Mongodump
 
-GitHub Action for creating a binary export of a database's contents
+A GitHub Action to create MongoDB backups efficiently and securely, using `mongodump` with password-protected compression.
 
-## Example usage
+## Features
 
-```yml
+- 🛡️ **Secure Backups**: Password-protected compressed backups for enhanced data security.
+- 🔄 **Simple Automation**: Automatically generate backups during CI/CD pipelines.
+- 🚀 **Docker-Based**: Lightweight and easy to use.
+- 📦 **Compatible with MongoDB 6**.
+
+---
+
+## Usage
+
+### 1. Workflow Configuration
+
+Add this Action to your GitHub workflow in the `.github/workflows/workflow.yml` file:
+
+```yaml
 name: Backup
 
 on:
   schedule:
     - cron: 0 0 * * *
 
 jobs:
-  backup:
+  mongodump:
+    name: Mongodump
     runs-on: ubuntu-latest
     steps:
       - uses: actalog/mongodump@v1
         with:
-          connection-string: ${{ secrets.MONGO_URI }}
-      - uses: actions/upload-artifact@v4
-        with:
-          name: dump
-          path: ${{ github.workspace }}/dump
+          connection-string: ${{ secrets.CONNECTION_STRING }}
+          output-password: ${{ secrets.OUTPUT_PASSWORD }}
 ```
 
-## Security
+### 2. Action Inputs
+
+| Parameter           | Required | Description                                         |
+|---------------------|----------|-----------------------------------------------------|
+| `connection-string` | Yes      | MongoDB connection URI (stored as a secret).        |
+| `output-password`   | Yes      | Password to protect the backup file.                |
+
+### 3. Setting Up Secrets
+
+Add the following secrets to your GitHub repository:
+
+1. **`CONNECTION_STRING`**: The connection URI for your MongoDB instance.
+2. **`OUTPUT_PASSWORD`**: The password to secure the backup file.
+
+---
+
+## License
 
-Remember that artifacts can be downloaded by anyone who has the artifact download link or access to the workflow run. Which means that you need to use a private repository if you want create backups and upload them as artifacts.
+This project is licensed under the terms of [The Unlicense](./LICENSE).

action.yml

@@ -1,16 +1,18 @@
 name: '@actalog/mongodump'
-description: GitHub Action for creating a binary export of a database's contents
+description: Creates a binary export of a database's contents
+branding:
+  icon: 'database'
+  color: 'green'
 
 inputs:
   connection-string:
     required: true
+  output-password:
+    required: true
 
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
     - ${{ inputs.connection-string }}
-
-branding:
-  icon: 'database'
-  color: 'green'
+    - ${{ inputs.output-password }}

entrypoint.sh

@@ -1,6 +1,13 @@
 #!/bin/sh -l
 
+apt update && apt upgrade -y
+apt install zip -y
+
 cd /action
 mongodump $1
+
+zip -P $2 -r dump.zip dump
+rm -rf dump
+
 mkdir $GITHUB_WORKSPACE/dump
-cp -r dump $GITHUB_WORKSPACE/dump
+cp -r dump.zip $GITHUB_WORKSPACE/dump