Features β
Deploy or Update a Portainer Stack from a Repository or Compose File. Supports both Swarm and Standalone Docker deployments for Portainer Community Edition and Business Enterprise Edition.
- Deploy or re-deploy an existing stack otherwise create a new stack.
- 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.
- Supports custom headers for services like Cloudflare Zero Trust.
- 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:
π Updated Existing 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 | 10/8/2025, 6:44:36 PM |
| Path | /data/compose/112 |
| EndpointID | 1 |
| SwarmID | wr8i8agdr05n6wsf1tkcnhwik |
Inputs
url: '***'
name: 'test_portainer-stack-deploy'
file: 'docker-compose.yaml'
endpoint: ''
ref: 'refs/heads/master'
repo: 'https://github.com/cssnr/portainer-stack-deploy-action'
tlsskip: false
prune: true
pull: true
type: 'file'
standalone: false
env_file: ''
merge_env: true
username: ''
password: ''
fs_path: ''
headers: {}
summary: trueYou 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.
Tags Security Notice β
As shown above, tags are mutable; however, commit hashes are not. Therefore, if security is your top priority, you should pin your actions to a specific commit hash.
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 Portainer 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.
Request a Feature
To request a feature, please open a feature request
