mittwald mStudio container deployment
ActionsTags
(1)This GitHub Action updates a mittwald container stack via the official Container API, using the Go SDK.
It supports flexible configuration using YAML files or inline YAML strings and includes support for templating using environment variables.
- Authentication using Mittwald API tokens
- Updates full container stacks using
UpdateStack - Supports stack configuration via:
- single
stack.yaml(services + volumes) - separate
services.yamlandvolumes.yaml - inline YAML via action
with:parameters
- single
- Supports environment variable templating in YAML (
{{ .Env.MY_VAR }})
Important
Note about the mStudio API
This action uses the UpdateStack endpoint of the mittwald Studio Container API.
This means every service in your stack is declared exactly as described in your YAML file – including ports, volumes, and environment variables.
🧨 Any manual changes made in the mStudio UI that are not reflected in your YAML configuration will be overwritten!
If you need to preserve manual adjustments, make sure to incorporate them into your version-controlled YAML files before deploying.
name: Deploy Stack
on:
push:
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Deploy to Mittwald
uses: mittwald/deploy-container-action@v1
env:
MYSQL_ROOT_PASSWORD: "${{ secrets.ROOT_PASS }}"
MYSQL_DATABASE: "testdb"
MYSQL_USER: "user"
MYSQL_PASSWORD: "${{ secrets.USER_PASS }}"
with:
api_token: ${{ secrets.MITTWALD_API_TOKEN }}
stack_id: "your-stack-id"
stack_file: "${{ github.workspace }}/configs/stack.yaml"services:
mydb:
image: "mysql:8.0"
description: "MySQL"
ports:
- "3306/tcp"
envs:
MYSQL_ROOT_PASSWORD: {{ .Env.MYSQL_ROOT_PASSWORD }}
MYSQL_DATABASE: {{ .Env.MYSQL_DATABASE }}
MYSQL_USER: {{ .Env.MYSQL_USER }}
MYSQL_PASSWORD: {{ .Env.MYSQL_PASSWORD }}
volumes:
- "mysql:/var/lib/mysql"
volumes:
mysql:
name: mydb-volumeTip
The placeholders like {{ .Env.MYSQL_ROOT_PASSWORD }} will be replaced using the environment variables at runtime.
You must provide these variables in the workflow's env block if they are used in your stack file:
env:
MYSQL_ROOT_PASSWORD: "rootpass"
MYSQL_DATABASE: "testdb"
MYSQL_USER: "user"
MYSQL_PASSWORD: "secret"with:
api_token: ${{ secrets.MITTWALD_API_TOKEN }}
stack_id: "your-stack-id"
services_file: "${{ github.workspace }}/configs/services.yaml"
volumes_file: "${{ github.workspace }}/configs/volumes.yaml"with:
api_token: ${{ secrets.MITTWALD_API_TOKEN }}
stack_id: "your-stack-id"
services_yaml: |
app:
image: "nginx"
description: "Nginx"
ports:
- "80/tcp"| Name | Required | Description |
|---|---|---|
api_token |
✅ | Mittwald API token; see the documentation on how to obtain one. |
stack_id |
✅ | Stack UUID to update. See the documentation on managing containers via the API to learn how to determine this id. |
stack_yaml / stack_file |
🔄 | Full stack (services + volumes) YAML |
services_yaml / services_file |
🔄 | Services-only YAML |
volumes_yaml / volumes_file |
🔄 | Volumes-only YAML |
skip_recreation |
❌ | Comma-separated list of services that should not be restarted after the stack was updated. Useful to avoid downtime for persistent services. |
After a stack is updated, services can optionally be restarted using the RecreateService API.
By default, all services will be restarted, unless you explicitly tell the action to skip specific ones.
Use the skip_recreation input to provide a comma-separated list of service names not to restart:
with:
skip_recreation: "mongodb"This is especially useful if you're managing a database or persistent service that shouldn't be restarted on every deployment.
If you want to restart all services, simply omit this input.
Note
Services are only restarted if the response from the UpdateStack API indicates that a restart is required.
This means that even if a service is not in the skip_recreation list, it will only be restarted if the stack update included relevant changes.
Tip
Service names must match the ones defined under services: in your YAML.
This action supports dynamic configuration using environment variables inside YAML files.
Example usage in YAML:
envs:
MONGODB_PASSWORD: {{ .Env.MONGODB_PASSWORD }}To make this work, you must define the variables in your workflow under the env: section:
env:
MONGODB_PASSWORD: ${{ secrets.DB_PASSWORD }}name: Deploy Mittwald Stack
on:
push:
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
env:
MONGODB_ROOT_PASSWORD: ${{ secrets.MONGO_ROOT_PW }}
ME_CONFIG_BASICAUTH_PASSWORD: ${{ secrets.MONGOEXPRESS_PW }}
steps:
- name: Checkout project
uses: actions/checkout@v4
- name: Deploy stack to Mittwald
uses: mittwald/deploy-container-action@v1
with:
api_token: ${{ secrets.MITTWALD_API_TOKEN }}
stack_id: "your-stack-id"
stack_file: "${{ github.workspace }}/configs/mstudio/container_stack.yaml"
skip_recreation: "mongodb"Several full example files are provided under the examples/ directory in this repository.
This action is written in Go and uses the official mittwald/api-client-go SDK (v2). See main.go for details.
Feel free to open issues or PRs — improvements and use-cases are welcome!
mittwald mStudio container deployment is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Tags
(1)mittwald mStudio container deployment is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.