Merge pull request #76 from mikesir87/add-docs-ci-workflows

Add docs about deploying Labspaces in CI workflows

Author: mikesir87

docs/README.md

@@ -6,6 +6,7 @@ This directory provides various documents on creating Labspaces.
 
 - [Creating a Labspace](./creating-labspace.md) - start here to learn how to create a Labspace
 - [Configuration](./configuration.md) - learn about the various configuration options to make the perfect Labspace
+- [Automating Labspace deployment](./deploying-in-ci.md) - learn how to publish your Compose file in CI for easy deployment
 - [Best practices](./best-practices.md) - learn about a few best practices on creating Labspaces
 
 

docs/automating-deployment.md

@@ -0,0 +1,47 @@
+# Automating Labspace Deployment
+
+Recognizing a deployed Labspace is simply a published Compose file, it's fairly easy to do so in CI.
+
+## Using GitHub Actions
+
+Before publishing using GitHub Actions, you will need to do the following:
+
+- Setup a `DOCKERHUB_USERNAME` and `DOCKERHUB_TOKEN` secret in GHA
+
+The following workflow definition will publish to Hub using the `.labspace/compose.override.yaml` file. You will need to swap out the `YOUR-HUB-REPO-NAME-HERE` with the name of your Docker Hub repo.
+
+```yaml
+name: Publish Labspace
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Ensure Compose v2.39.3+ is available (includes bug fixes for publishing)
+      # Can remove this action once default runners include it
+      - name: Set up Docker Compose
+        uses: docker/setup-compose-action@v1
+        with:
+          version: v2.39.3
+
+      - name: Log in to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Publish Compose file
+        run: |
+          docker compose -f oci://dockersamples/labspace -f .labspace/compose.override.yaml publish $DOCKERHUB_USERNAME/YOUR-HUB-REPO-NAME-HERE --with-env -y
+        env:
+          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+
+```