Deploy a Collection to Ansible Galaxy
A GitHub Action to build and publish Ansible Galaxy collections with version control and deployment automation.
What is Deploy a Collection to Ansible Galaxy?
ansible_galaxy_collection is a GitHub Action designed to automate the deployment of Ansible Galaxy collections. It builds collections into archive files and publishes them to Ansible Galaxy, handling version injection and error reporting. The tool solves the problem of manual, error-prone collection releases by integrating directly into CI/CD pipelines.
Ansible collection maintainers and DevOps engineers who manage Ansible content and want to automate publishing to Ansible Galaxy via GitHub Actions.
Developers choose this Action because it provides a standardized, reliable way to deploy collections with features like dynamic versioning and flexible build/publish controls, reducing deployment complexity and integration effort.
Overview
Deploy a Collection to Ansible Galaxy.
Use Cases
Best For
- Automating Ansible Galaxy collection releases from GitHub repositories
- Injecting dynamic version numbers into collections during CI/CD pipelines
- Building collection archives without immediate publication for testing
- Publishing pre-built collection archives to Ansible Galaxy
- Managing collections stored in non-standard directory structures
- Implementing error-handling and validation in collection deployment workflows
Not Ideal For
- Teams using CI/CD platforms other than GitHub Actions (e.g., GitLab CI, Jenkins)
- Projects requiring automated version incrementing without manual scripting (galaxy_version_increment is TBA)
- Collections with custom archive naming or build processes that deviate from Ansible Galaxy's default format
Pros & Cons
Pros
Allows injecting semver-compatible versions into galaxy.yml at deployment time, enabling version control from CI/CD triggers like tags or environment variables.
Separate build and publish inputs let users create archives for testing without publishing or publish pre-built archives, adding deployment flexibility.
The collection_dir input supports collections stored outside the project root, accommodating varied repository structures without restructuring.
Provides specific exit codes (e.g., DeployFailed, ValidationFailed) with detailed logs, making it easier to debug failures in automated workflows.
Cons
The README notes galaxy_version_increment is 'TBA', so automatic version bumps aren't supported, requiring external tools or manual updates.
As a GitHub Action, it locks users into GitHub's ecosystem, making it unsuitable for teams using other CI/CD platforms or self-hosted solutions.
When build is false, it expects archives in the default Ansible Galaxy naming format, which may not align with custom build pipelines or legacy setups.
Frequently Asked Questions
Related Projects
Executing remote ssh commandsGitHub Actions for executing remote ssh commands.
FTP Deploy Action, Deploys a GitHub project to a FTP server using GitHub actionsDeploys a GitHub project to a FTP server using GitHub actions
Copy files and artifacts via SSHGitHub Action that copy files and artifacts via SSH.
Publish a Python distribution package to PyPIThe blessed :octocat: GitHub Action, for publishing your :package: distribution files to PyPI, the tokenless way: https://github.com/marketplace/actions/pypi-publish
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.