Commit 47d2992a authored by Laurent Peuch's avatar Laurent Peuch
Browse files

doc: update README with how to add each rule to `.cube-doctor.yml`

parent ba5bf2d88c19
......@@ -120,6 +120,13 @@ This command will:
- replace "README" by "README.rst" in setup.py if present
- replace "README" by "README.rst" in MANIFEST.in if present or add "include README.rst" at the end of it
Snippet for adding this command in your `.cube-doctor.yml`:
.. code:: yaml
rules:
fix-README:
add-pytest-deprecated-warnings-cmd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -129,6 +136,11 @@ This command will:
- or if a dev-requirements.txt exist, add it into it instead
- modify .gitlag-ci.yml "py3" section to add "py3-deprecated-warnings.json" has an artifact
.. code:: yaml
rules:
add-pytest-deprecated-warnings:
release-new
~~~~~~~~~~~
......@@ -142,6 +154,7 @@ This command is a bit WIP. It will:
- add a base tox.ini in a repository if it doesn't exist
- it will also launch this tox and fail if the tox fails
Snippet for adding this command in your `.cube-doctor.yml`:
replace-set-attributes-by-set-cw
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -151,6 +164,13 @@ This command will:
- retrieve all the Python files inside the cube
- for each file, replace all occurences of set_attributes calls by set_cw calls
Snippet for adding this command in your `.cube-doctor.yml`:
.. code:: yaml
rules:
replace-set-attributes-by-set-cw:
update-licence-dates
~~~~~~~~~~~~~~~~~~~~
......@@ -159,6 +179,13 @@ This command will:
- for each file, if it has a licence part in comments, extend the licence end date to
the current year.
Snippet for adding this command in your `.cube-doctor.yml`:
.. code:: yaml
rules:
update-licence-dates:
Advanced command
----------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment