diff --git a/.github/workflows/docker-deploy.yml b/.github/workflows/docker-deploy.yml new file mode 100644 index 0000000..d26b5b4 --- /dev/null +++ b/.github/workflows/docker-deploy.yml @@ -0,0 +1,28 @@ +name: Deploy to Docker Hub + +on: + push: + branches: [ main ] + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Log in to Docker Hub + uses: docker/login-action@v2 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - name: Make build script executable + run: chmod +x ./build.sh + + - name: Build and push Docker image + run: ./build.sh -t -p \ No newline at end of file diff --git a/README.md b/README.md index 8b16582..4da1988 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,29 @@ mermaid charts: remember expanded modules as well as scorll position +## Automated Docker Hub Deployment + +This repository includes a GitHub Actions workflow that automatically builds and deploys Docker images to Docker Hub when code is pushed to the `main` branch. + +### Required Secrets + +To enable automated deployment, add the following secrets to your GitHub repository: + +- `DOCKERHUB_USERNAME`: Your Docker Hub username +- `DOCKERHUB_TOKEN`: Your Docker Hub access token (not password) + +### How it works + +The workflow: +1. Triggers on any push to the `main` branch +2. Checks out the code +3. Sets up Docker Buildx +4. Authenticates to Docker Hub using the provided secrets +5. Runs the existing `build.sh` script with tag and push flags to build and deploy the image + +The deployed image will be available at `alexmickelson/canvas_management` with appropriate version tags. + + ## Features - websocket server to watch file system for changes, notify frontend it should invalidate cache - files can be edited in any text editor on the computer and changes are reflected in real time on the site