Move to Red Hat¶
During the end of October 2018 the Molecule Project was moved to its new home under Ansible by Red Hat.
How to get involved¶
Update Git repo location¶
The Molecule project has moved:
If you have the source checked out you should use
git remote set-url origin
to point to the new location.
Please follow GitHub’s official changing a remote’s URL guide.
New Docker location¶
For people that use the Docker image, we are now publishing to a new location Molecule on quay.io.
How to use:
docker pull quay.io/ansible/molecule:latest
We are interested in various different kinds of improvement for Molecule; please feel free to raise an Issue if you would like to work on something major to ensure efficient collaboration and avoid duplicate effort.
Create a topic branch from where you want to base your work.
Make sure you have added tests for your changes.
Although not required, it is good to sign off commits using
git commit --signoff, and agree that usage of
--signoffconstitutes agreement with the terms of DCO 1.1.
Run all the tests to ensure nothing else was accidentally broken.
Reformat the code by following the formatting section below.
Submit a pull request.
Pull Request Life Cycle and Governance¶
Working with InterSphinx¶
In the conf.py, we define an
intersphinx_mapping which provides the base
URLs for conveniently linking to other Sphinx documented projects. In order to
find the correct link syntax and text you can link to, you can quickly inspect
the reference from the command line.
For example, if we would like to link to a specific part of the Ansible documentation, we could first run the following command:
python -m sphinx.ext.intersphinx https://docs.ansible.com/ansible/latest/objects.inv
And then see the entire Sphinx listing. We see entries that look like:
py:attribute AnsibleModule._debug api/index.html#AnsibleModule._debug
With which we can link out to using the following syntax: