portainer-compose

Portainer-Compose is designed to simplify the management of Docker stacks using GitHub Actions and Portainer. This project facilitates several critical tasks involving Docker stack automation, allowing users to seamlessly integrate their development workflows with container management.

Key Features:

• YAML File Management: Add new YAML files directly to your Docker stack and manage them from a central repository.
• Stack Deletion: Effortlessly delete existing Docker stacks from the SwarmPit interface, streamlining stack management processes.
• GitHub Integration: Create new stacks in Portainer directly from a GitHub repository, enhancing version control and collaboration.

Actions Supported:

1. Add a YAML file to the .github/workflows folder for automated workflow management.
2. Retrieve all necessary webhooks from Portainer to manage deployments as environment variables.
3. Execute jobs based on commit messages, enabling a more descriptive deployment workflow.
4. Utilize conditional execution to manage job triggers based on specific criteria, ensuring flexibility and control over deployment processes.

Workflow for Adding a New Stack:

To enhance the deployment of stacks, the following steps should be executed using the source control of this repository:

1. Create a new YAML file that defines the stack configuration.
2. Set up a new stack in Portainer and activate the webhook function to enable automated deployments.
3. Incorporate the webhook as an environment variable in the actions configuration file.
4. Commit the stack name to trigger the redeployment process, promoting continuous integration practices.

Useful Links:

For further guidance on utilizing Portainer with GitHub Actions, the following resources are available:

• GitHub Actions Documentation
• Enabling Webhook on Portainer Stack
• Creating a Webhook in GitHub
• Continuous Deployment with Portainer

Portainer-Compose is a powerful tool for developers looking to integrate container management into their CI/CD pipelines efficiently.