Merge pull request #2 from rcknr/composite-update

Update and convert to composite action

Author: avallete

.github/workflows/snaplet-restore.yml

@@ -16,52 +16,37 @@ jobs:
       postgres:
         image: postgres:latest # Must match the database where snapshot was taken
         env:
+          PGDATA: /data # Important: data location has to be changed as default is defined as a volume, so snapshot won't persist
           POSTGRES_PASSWORD: postgres
           POSTGRES_USER: postgres
-          POSTGRES_DB: videolet
+          POSTGRES_DB: snapshot
         options: >-
           --health-cmd pg_isready
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
+          --name snapshot
         ports:
           - 5432:5432
 
     steps:
       - name: Checkout Repository Code
         uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '16'
-          cache: 'yarn'
-
-      - name: Install Dependencies
-        run:  yarn install --frozen-lockfile
-
-      - name: Build
-        run:  yarn build
-
+        
       - name: Login to Docker Hub
         uses: docker/login-action@v1
         with:
           registry: ${{ secrets.GHCR_CONTAINER_REGISTRY_SERVER }}
           username: ${{ secrets.GHCR_CONTAINER_REGISTRY_USER }}
           password: ${{ secrets.GHCR_CONTAINER_REGISTRY_PASSWORD }}
 
-      - name: Install Snaplet
-        run: curl -sL https://app.snaplet.dev/get-cli/ | bash
-
       - name: Snaplet Restore
         uses: ./
         with:
-          docker-container-registry-user: snaplet
-          docker-image-name: publish-postgres-with-data-docker-action_database
+          docker-container-name: snapshot
+          docker-image-tag: ghcr.io/snaplet/publish-postgres-with-data-docker-action_database
+          snaplet-database-url: postgres://postgres:postgres@localhost:5432/snapshot
         env:
           SNAPLET_ACCESS_TOKEN: ${{ secrets.SNAPLET_ACCESS_TOKEN }}
-          SNAPLET_DATABASE_ID: ckq46skzy358532hraos3ptc7p
-          SNAPLET_RESTORE_DB_NAME: videolet
-          PGHOST: localhost
-          PGUSER: postgres
-          PGPASSWORD: postgres
-          PGPORT: 5432
-          PGDATABASE: videolet
+          SNAPLET_PROJECT_ID: ${{ secrets.SNAPLET_PROJECT_ID }}
+          

README.md

@@ -1,34 +1,26 @@
 # Introduction
 
-Snaplet's Github action lets your create safe database snapshots on-demand.
+This action lets your restore a Snaplet snapshot into a Docker container and push it to your registry for later use.
+To use it you need to create a workflow with a service container running a database. This container will be populated with data and pushed to a registry.
 
 # Inputs
 
-## `docker-container-registry-user`
+## `docker-container-name`
 
-**required** The name of docker registry user.
+**required** Name of the docker container running the database.
 
-## `docker-container-registry-server`
+## `docker-image-tag`
 
-The URL of docker registry server. Default `ghcr.io`
+**required** A tag to apply and push the image with. Must be fully qualified including registry URL e.g. `ghcr.io/snaplet/snaplet-snapshot:latest`.
 
-## `docker-image-tag`
+## `snaplet-database-url`
+
+**required** A connection string to use to restore a snapshot.
+
+## `snaplet-restore-command`
 
-The name of the docker image tag to use. Default `snaplet_database`.
+A command to run to restore a snapshot. Default `snaplet snapshot restore --latest`.
 
 ## Example usage
 
-```
-uses: snaplet/publish-postgres-with-data-docker-action@main
-with:
-  docker-container-registry-user: <docker-registry-user>
-  docker-image-tag: <docker-image-tag>
-env:
-  SNAPLET_ACCESS_TOKEN: ${{ secrets.SNAPLET_ACCESS_TOKEN }}
-  SNAPLET_DATABASE_ID: <snaplet-database-id>
-  PGHOST: localhost
-  PGUSER: postgres
-  PGPASSWORD: postgres
-  PGPORT: 5432
-  PGDATABASE: <restore-database-name>
-```
+Apart from inputs this action expects standard Snaplet environment variables to authenticate the CLI. See example workflow in `.github/workflows/snaplet-restore.yml`.

action.yml

@@ -2,17 +2,40 @@ name: Postgres Docker image with "baked-in" data
 author: Snaplet, Inc.
 description: Creates a Postgres Docker Image, with data from a Snaplet snapshot, for restoration in Codespaces, development environments.
 inputs:
-  docker-image-name:
-    description: Name of docker image
-    required: false
-    default: snaplet_database
-  docker-container-registry-server:
-    description: URL of docker registry server
-    required: false
-    default: ghcr.io
-  docker-container-registry-user:
-    description: Name of docker registry user
+  docker-container-name:
+    description: Name of docker database container
+    required: true
+    type: string
+  docker-image-tag:
+    description: Tag for docker image
     required: true
+    type: string
+  snaplet-database-url:
+    description: Connection string to restore a snapshot
+    required: true
+    type: string
+  snaplet-restore-command:
+    description: Command used to restore a snapshot
+    required: false
+    type: string
+    default: snaplet snapshot restore --latest
 runs:
-  using: "node12"
-  main: "dist/index.js"
+  using: "composite"
+  steps:
+    - name: Install Snaplet
+      run: |
+        curl -sS "https://app.snaplet.dev/get-cli/" | bash &> "/dev/null"
+        echo "$HOME/.local/bin" >> "$GITHUB_PATH"
+      shell: bash
+
+    - name: Restore snapshot
+      run: ${{ inputs.snaplet-restore-command }}
+      shell: bash
+      env:
+        SNAPLET_TARGET_DATABASE_URL: ${{ inputs.snaplet-database-url }}
+
+    - name: Commit and push Docker image
+      run: |
+        docker commit ${{ inputs.docker-container-name }} ${{ inputs.docker-container-tag }}
+        docker push ${{ inputs.docker-container-tag }}
+      shell: bash