Features
Deploy or Update a Portainer Stack from a Repository or Compose File. Supports both Swarm and Standalone Docker deployments for Portainer Community and Business Enterprise Edition.
- Deploy a new stack or update existing one.
- Deploy from a repository or a compose file, see type.
- Deploy from a different repo than the current one.
- Provide environment variables in JSON or file format.
- Automatically parse Endpoint ID if only one endpoint.
- Supports Docker Swarm and Docker Standalone.
- To view all features see the Inputs Documentation.
You can get started here or view workflow examples.
Request a Feature
If you need more options, please open a feature request
Job Summary
Unless disabled, a Job Summary is generated to capture the command, output and errors.
Example Job Summary
🎉 Created New Stack 112: test_portainer-stack-deploy
Stack Details
| Item | Value |
|---|---|
| ID | 112 |
| Name | test_portainer-stack-deploy |
| File | docker-compose.yml |
| Type | Swarm |
| Status | Active |
| Created | 2/28/2025, 3:09:16 AM |
| Updated | - |
| Path | /data/compose/112 |
| EndpointID | 1 |
| SwarmID | wr8i8agdr05n6wsf1tkcnhwik |
You can view an actual workflow run from the Test job on GitHub (requires login).
Rolling Tags
The following rolling tags are maintained to improve stability across updates.
| Version Tag | Rolling | Bugs | Feat. | Name | Target | Example |
|---|---|---|---|---|---|---|
 | ✅ | ✅ | ✅ | Major | vN.x.x | vN |
 | ✅ | ✅ | ❌ | Minor | vN.N.x | vN.N |
 | ❌ | ❌ | ❌ | Micro | vN.N.N | vN.N.N |
You can view the release notes for each version on the releases page.
The Major tag is recommended. It is the most up-to-date and always backwards compatible. Breaking changes would result in a Major version bump. At a minimum you should use a Minor tag.
Action Comparison
The majority of other actions available have not been recently updated and most of them are forks and clones of each other.
This action was built from the ground up with an easily extendable API to provide any feature needed to deploy any Portainer stack from any GitHub Action.
The goal of this action is to be the ultimate Docker deployment action on GitHub. To date all issue have been fixed and all feature requests added.
WARNING
None of these actions have been tested. This is an exhaustive list of published actions.
Updated - Link to Pulse (activity)
Language - Link to Dependants (users)
If there are any missing features you need, please submit a feature request and we will get them added...