Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roles-ansible/check-ansible-debian-stable-action

Github Action to check ansible roles with the debian:stable docker image
https://github.com/roles-ansible/check-ansible-debian-stable-action

ansible check-ansible debian github-actions

Last synced: about 1 month ago
JSON representation

Github Action to check ansible roles with the debian:stable docker image

Awesome Lists containing this project

README

        

[![Github Marketplace](https://raw.githubusercontent.com/roles-ansible/check-ansible-debian-stable-action/master/.github/marketplace.svg?sanitize=true)](https://github.com/marketplace/actions/check-ansible-debian-stable)
[![MIT License](https://raw.githubusercontent.com/roles-ansible/check-ansible-debian-stable-action/master/.github/license.svg?sanitize=true)](https://github.com/roles-ansible/check-ansible-debian-stable-action/blob/master/LICENSE)

Check Ansible Debian stable
=======================
This action allows you to test your ansible role or your playbook in a Docker Container with ``debian:stable``.

## Usage
To use the action simply create an ``ansible-debian-stable.yml`` *(or choose custom ``*.yml`` name)* in the ``.github/workflows/`` directory.

For example:

```yaml
name: Ansible check debian:stable # feel free to pick your own name

# yamllint disable-line rule:truthy
on: [push, pull_request]

jobs:
build:

runs-on: ubuntu-latest

steps:
# Important: This sets up your GITHUB_WORKSPACE environment variable
- uses: actions/checkout@v2

- name: ansible check with debian:stable
# replace "master" with any valid ref
uses: roles-ansible/check-ansible-debian-stable-action@master
with:
targets: "./"
# [required]
# Paths to your ansible role or playboox.yml you want to test
# Some Examples:
# targets: "role/my_role/"
# targets: "site.yml"
#
# group: ""
# [optional]
# When testing playbooks you have to tell ansible
# the group you that we write in our hosts file.
# example:
# group: 'servers'
#
# hosts: ""
# [optional]
# When testing playbooks you have to give one example
# host this action should use to test your playbook.
# > We only spawn one docker container that mean
# > we can only test one host at the time. Sorry
# some examples:
# hosts: 'localhost'
# hosts: 'srv01.example.com'
#
# requirements
# [optional]
# When testing playbooks and you are using ansible galaxy,
# you may be interested in installing your requirements
# from ansible galaxy.
# To do this please provide us either the role name directly
# requirements: 'do1jlr.ansible_version'
# or your requiements.yml file.
# requirements: 'requirements.yml'
```

Alternatively, you can run the ansible check only on certain branches:

```yaml

on:
push:
branches:
- stable
- main
- release/v*
```

or on various [events](https://help.github.com/en/articles/events-that-trigger-workflows)


Contributing
-------------
If you are missing a feature or see a bug. Please report it. Or - if you like - open a pull-request.

License
----------
The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).

Credits
--------------
The initial GitHub action has been created by [Stefan Stölzle](https://github.com/stoe) at
[stoe/actions](https://github.com/stoe/actions).

It was used by ansible for lint checks at [ansible/ansible-lint-action](https://github.com/ansible/ansible-lint-action.git)

It was modified from [L3D](https://github.com/do1jlr) to check ansible roles.