Using content best practices for reliable, consistent automation

• Add tox entry for lint
• Run sanity tests with tox-ansible

This will live in the User Guide page.

Testing a user-facing role within a collection
Use molecule to write a test, wrap molecule with pytest-ansible parameterization, use tox-ansible to run the scenario across all current python/ansible core versions

User Guide will have two sections:

• links to tool docs etc. Link to the ecosystem docs and each repo
• Common operations using 2 or more tools (cross tools)

Cross tool Common operations are described in the task list.

Incorporating Ansible developer tools into ci workflows

• Use monolithic GHA to check PRs
• Run unit and sanity tests plus lint
• Publishing collections to Galaxy

This will live in the User Guide page.

Set up CI
Use the monolithic github action as a PR gate to set up a repo for running unit, sanity, lint

Before we get too far along here, let's swith this one to calver instead of semantic.

Testing roles

• Molecule
• wrap molecule with pytest-ansible parameterization
• tox-ansible to run the scenario across all current python/ansible core versions

Ansible Developer Tools (brief - this is the documentation home page)

• (highlight) Single point for installation
• (highlight) Combination of tools vetted and used by previous content authors
• (highlight) The SDK reflects the tools used by certified and validated content developers
• (highlight) Introduces tools that a developer may be less familiar with
• (tools - what and how they are used together and for what purpose)
• (author) 1-2 paragraphs for each tool highlighting key functionality, can probably be harvested from existing READMEs and dos.
• Identify how each tool is valuable during local interactive development, local testing. and then in a CI pipeline (linting and testing)
• (highlight) Same tools and outcomes locally and in CI
• (note) include the extension in the enumeration of the tools. Although it is not packaged with the python of rpm pkg, it is an integral part of the experience

The CLI will change to adt

Referred to formally as Ansible automation developer tools

Delete the 1.0.0 release and tag, leaving that for January

Releases before then should < 1.0.0

Contributor Guide

• Code of conduct and general how to contribute to the project.
• Communications channels (matrix, forum, meetings etc)
• Developer/ PR guidelines (if needed)

Creating collections of automation content

• Scaffold with creator
• ade (pip4a) to install it editable with python deps in a venv
• Lint
• Navigator

This will live in the User Guide page.
Bootstrap a new collection
Use of creator to scaffold, ade (pip4a) to install it editable with python deps in a venv, use the extension with lint to author, playbook or navigator to run

The docs for ansible-dev-tools appears temporarily incorrect since there's not a release on pypi marked stable, the command pip install ansible-dev-tools fails, but pip install ansible-dev-tools==0.2.0a0 is successful.

Ansible developers tools (ansible-dev-tools) is an opinionated collection of tools that enable automation developers to create and test Ansible automation quickly and effectively. To clearly communicate what tools are available and support these objectives, the tools that makeup the ansible-dev-tools should be easy to install with one command.

The tools in the initial release of the ansible-dev-tools will be:

• ansible-lint (Ansible lint)
• molecule (Ansible Molecule)
• ansible-navigator (automation content navigator)
• pytest-ansible plugin
• tox-ansible plugin
• ade (Ansible development environment formerly pip4a)
• ansible-builder (execution environment builder)**
• ansible-sign
• ansible-creator (Ansible creator)
• Documentation to include the extension, even though it is not co-packaged

Getting started with Ansible Developer Tools

• Walk through the creation and release of a simple collection

This will live in the User Guide page.

Ensuring content best practices
Add a “regular” tox entry for lint, and use tox to run it, run sanity tests using tox-ansible

Lay down the framework for a new python project

Deps:

ansible-lint
ansible-navigator
molecule
ansible-builder
pytest-ansible
tox-ansible
scaffolding tool (future)

This will live in the User Guide page.

Publishing a collection
Use the monolithic github action to push to galaxy, mention AH token refresh and how to set that up.

Installation

• Install, uninstall
• Upgrade - porting guide/changelogs (Github generated/ point to releases)

The Usage of ADT in README is not showing ansible-dev-environment in the list. This needs to be updated https://github.com/ansible/ansible-dev-tools#usage

Moved to user guide

• Getting Started
• Creating collections of automation content
• Testing roles
• Using content best practices for reliable, consistent automation
• Incorporating Ansible developer tools into ci workflows

Add a command line option to check if the packages that part of CDK are installed or not and provide a way to identify which packages are not installed.

Creator tool is missing in the Installation page https://ansible.readthedocs.io/projects/dev-tools/installation/#usage-design-review.
Missing in the Included packages list https://ansible.readthedocs.io/projects/dev-tools/#included-packages

This documentation article refers to "Ansible development tools" as "ADT" which is not approved under Red Hat brand guidelines.

Only "Ansible development tools" is allowed (see row 156 in this spreadsheet: https://docs.google.com/spreadsheets/d/1DLS_lS3VKidgZIvcLmLp9BoiqptkvqHWfe1D5FD2kfk/edit#gid=1375785039)

Please remove the use of ADT through this doc.

thanks!