{"id":13573132,"url":"https://github.com/robertdebock/ansible-generator","last_synced_at":"2025-02-24T23:44:48.207Z","repository":{"id":48398399,"uuid":"225793114","full_name":"robertdebock/ansible-generator","owner":"robertdebock","description":"Generate documentation and continuous integration files for an Ansible Role.","archived":false,"fork":false,"pushed_at":"2024-12-19T08:48:39.000Z","size":191,"stargazers_count":59,"open_issues_count":2,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T10:28:46.977Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robertdebock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-04T06:12:57.000Z","updated_at":"2024-12-30T22:24:41.000Z","dependencies_parsed_at":"2024-03-04T09:31:21.562Z","dependency_job_id":"29cef740-e64d-42a7-840d-acf8bb06d7f6","html_url":"https://github.com/robertdebock/ansible-generator","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertdebock","download_url":"https://codeload.github.com/robertdebock/ansible-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240576486,"owners_count":19823293,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:00:30.358Z","updated_at":"2025-02-24T23:44:48.183Z","avatar_url":"https://github.com/robertdebock.png","language":"Jinja","funding_links":[],"categories":["Jinja"],"sub_categories":[],"readme":"# ansible-generator\n\nGenerate documentation and continuous integration files for an Ansible Role.\n\nThe intention is to focus on writing or maintaining the Ansible role, and use this tool to generate chore-like-tasks.\n\n## Overview\n\n```text\n+--- role ----------------------+                     +--- role -------------------------------+\n| meta/main.yml                 |                     | README.md                              |\n| molecule/default/converge.yml |                     | bug_report.md                          |\n| meta/preferences.yml          |                     | feature_requests.md                    |\n| requirements.yml              |                     | FUNDING.md                             |\n| molecule/default/prepare.yml  |                     | .gitignore                             |\n| molecule/default/verify.yml   |                     | .pre-commit.config.yaml                |\n| defaults/main.yml             |                     | .yamllint                              |\n+------------------------+------+                     | .ansible-lint                          |\n                         |                            | CONTRIBUTING.md                        |\n+--- this tool -----+    |                            | .github/workflows/galaxy.yml           |\n| defaults/main.yml | ---+                            | .gitlab-ci.yml                         |\n| vars/main.yml     |    |                            | LICENSE                                |\n| files/*           |    |                            | .github/workflows/molecule.yml         |\n| templates/*       |    |                            | molecule/default/molecule.yml          |\n+-------------------+    |    +--- this tool ---+     | .github/workflows/requirements2png.yml |\n                         +--\u003e | generate.yml    | --\u003e | SECURITY.md                            |\n                              +-----------------+     | settings.yml                           |\n                                                      | .github/workflows/todo.yml             |\n                                                      | .tox.ini                               |\n                                                      +----------------------------------------+\n```\n\n## Usage\n\n```bash\ncd ansible-role-my_role\n../path/to/generate.yml\n```\n\n## Configuration\n\nIn `defaults/main.yml` you can change these variable to customize the output.\n\n### Settings to Docker containers\n\n- `docker_namespace`\n- `docker_image`\n- `docker_tag`\n\n### Your username on Galaxy\n\n- `galaxy_namespace`\n\n### Your username/organization name on GitHub\n\n- `github_namespace`\n\n### Your username/group on GitLab\n\n- `gitlab_namespace`\n\n### Your name and optionally email-address\n\n- `author`\n\n### The full URL to your website\n\n- `author_website`\n\n## meta/preferences.yml\n\nThis (optional) file describes how Tox and Molecule should behave.\n\n|parameter               |type           |default|description                                                                                                                                              |\n|------------------------|---------------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n|tox_ansible_versions    |list of strings|[[5,6,7]](https://github.com/robertdebock/ansible-generator/blob/master/templates/tox.ini.j2#L7)|What versions should Tox test? (Default: all.)                                                                                                           |\n|github_variables_mapping|list           |not set|A list of `name` and `variable`, `name` refers to the GitHub exposed name, `variable` refers to the name you'd like to pass to molecule, tox and Ansible.|\n\n## Example\n\n```yaml\n---\ntox_ansible_versions:\n  - 6\n  - 7\n\ngithub_variables_mapping:\n  - name: secrets.VAULT_LICENSE\n    variable: VAULT_LICENCE\n  - name: secrets.MY_VAR\n    variable: someTHING\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertdebock%2Fansible-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertdebock%2Fansible-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertdebock%2Fansible-generator/lists"}