From ada9f6adf8ee512a28782d633f9c92aff55db07b Mon Sep 17 00:00:00 2001 From: Laurent Indermuehle Date: Mon, 23 Jan 2023 13:54:41 +0100 Subject: [PATCH] Add bold --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f3e8d1..deb3b71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,20 +9,20 @@ Refer to the [review checklist](https://docs.ansible.com/ansible/devel/community You can use GitHub to run ansible-test either on the community repo or your fork. But sometimes you want to quickly test a single version or a single target. To do that, you can use the Makefile present at the root of this repository. -Actually, the makefile only support Podman. I don't have tested with docker yet. +Actually, the makefile only support Podman. The Makefile accept the following options: -- ansible: Mandatory version of ansible to install in a venv to run ansible-test. -- docker_image: +- **ansible**: Mandatory version of ansible to install in a venv to run ansible-test. +- **docker_image**: The container image to use to run our tests. Those images Dockerfile are in https://github.com/community.mysql-test-containers and then pushed to quay.io: E.G.: `quay.io/mws/community-mysql-test-containers-my57-py38-mysqlclient201-pymysql0711:latest`. Look in the link above for a complete list of available containers. You can also look into `.github/workflows/ansible-test-plugins.yml` Unfortunatly you must provide the right container_image yourself. And you still need to provides db_engine_version, python, etc... because ansible-test won't do black magic to try to detect what we expect. Explicit is better than implicit anyway. To minimise the amount of images, pymysql 0.7.11 and mysqlclient are shipped together. -- db_engine_version: The name of the container to use for the service containers that will host a primary database and two replicas. Either MYSQL or MariaDB. Use ':' as a separator. Do not use short version, like mysql:8 for instance. Our tests expect a full version to filter tests precisely. For instance: `when: db_version is version ('8.0.22', '>')`. -- connector: The name of the python package of the connector along with its version number. Use '==' as a separator. -- python: The python version to use in the controller. -- target : If omitted, all test targets will run. But you can limit the tests to a single target to speed up your tests. +- **db_engine_version**: The name of the container to use for the service containers that will host a primary database and two replicas. Either MYSQL or MariaDB. Use ':' as a separator. Do not use short version, like mysql:8 for instance. Our tests expect a full version to filter tests precisely. For instance: `when: db_version is version ('8.0.22', '>')`. +- **connector**: The name of the python package of the connector along with its version number. Use '==' as a separator. +- **python**: The python version to use in the controller. +- **target** : If omitted, all test targets will run. But you can limit the tests to a single target to speed up your tests. Examples: