Contributor Guide¶

To contribute to ansible-dev-tools python package or to the list of tools part of it, please use pull requests on a branch of your own fork.

After creating your fork on GitHub, you can do:

$ git clone --recursive [email protected]:your-name/developer-tool-name
$ cd developer-tool-name
$ git checkout -b your-branch-name
# DO SOME CODING HERE
$ git add your new files
$ git commit -v
$ git push origin your-branch-name

You will then be able to create a pull request from your commit.

Prerequisites:

All fixes to core functionality (i.e. anything except docs or examples) should be accompanied by tests that fail prior to your change and succeed afterwards.
Before sending a PR, make sure that tox -e lint passes.

Feel free to raise issues in the repo if you feel unable to contribute a code fix.

Container testing¶

pytest has been extended to facilitate testing a container.

Custom options:
  --container-engine=CONTAINER_ENGINE
                        Container engine to use. (default=ADT_CONTAINER_ENGINE, podman, docker, '')
  --container-name=CONTAINER_NAME
                        Container name to use for the running container. (default=ADT_CONTAINER_NAME)
  --image-name=IMAGE_NAME
                        Container name to use. (default=ADT_IMAGE_NAME)
  --only-container      Only run container tests
  --include-container   Include container tests

Container tests can be run with either of the following commands:

# Run the tests against the default container engine
pytest --only-container
pytest --only-container --container-engine=<ce> --image-name <image>
tox -e test-image
tox -e test-image -- --container-engine=<ce> --image-name <image>

See the tests/integration/test_container.py for examples.

Manual testing of devspaces container¶

At this moment the devspaces container is not tested by the CI, so it is important to test it manually before merging any changes.

Get the checksum of the temporary container made from your pull request, the containers are pushed to https://github.com/ansible/ansible-dev-tools/pkgs/container/ansible-devspaces-tmp
Open an already made
https://console.redhat.com/openshift/sandbox

Talk to us¶

Join the Ansible forum:
Get Help: get help or help others. Please add appropriate tags if you start new discussions, for example the devtools tag.
Posts tagged with 'devtools': subscribe to participate in project-related conversations.
Social Spaces: gather and interact with fellow enthusiasts.
News & Announcements: track project-wide announcements including social events.
Bullhorn newsletter: used to announce releases and important changes.
We are also available on Matrix in the #devtools:ansible.com room.

Possible security bugs should be reported via email to security@ansible.com.

For more information about communication, see the Ansible communication guide.

Code of Conduct¶

Please see the official Ansible Community Code of Conduct.