mergify: document each step

+ move merge related things as the last in the list there.

Author: 0xc0170

.mergify.yml

@@ -22,7 +22,7 @@
 # For instance for needs: work if CI failed, we just add a label as action.
 
 pull_request_rules:
-  # From review to needs: work - reviewers request
+  # From needs: review to needs: work - reviewers request
   - name: "label needs: work when changes were requested"
     conditions:
       # Reviewers
@@ -34,7 +34,7 @@ pull_request_rules:
         remove: 
           - "needs: review"
 
-  # From review to needs: work - CI failure
+  # From needs: review to needs: work - CI failure
   - name: "label needs: work when travis-ci failed"
     conditions:
       # Travis failing
@@ -46,7 +46,7 @@ pull_request_rules:
         remove: 
           - "needs: review"
 
-  # From review to needs: work - CI failure
+  # From needs: review to needs: work - CI failure
   - name: "label needs: work when Jenkins CI failed - pr head"
     conditions:
       # Jenkins CI failing
@@ -58,7 +58,7 @@ pull_request_rules:
         remove: 
           - "needs: review"
 
-  # From review to needs: work - CI failure
+  # From needs: review to needs: work - CI failure
   - name: "label needs: work when Jenkins CI failed - any of the pipeline"
     conditions:
       # Jenkins CI failing - any of the pipeline
@@ -70,6 +70,7 @@ pull_request_rules:
         remove: 
           - "needs: review"
 
+  # From needs: review to needs: CI
   - name: "label needs: CI when at least one reviewers approval"
     conditions:
       # Labels
@@ -91,23 +92,7 @@ pull_request_rules:
         remove: 
           - "needs: review"
 
-  - name: remove ready for merge when merged
-    conditions:
-      - merged
-      - label=ready for merge
-    actions:
-      label:
-        remove:
-          - ready for merge
-
-  - name: add "do not merge" label when WIP is in title
-    conditions:
-       - title~=^(\[wip\]( |:) |\[WIP\]( |:) |wip( |:) |WIP( |:)).*
-    actions:
-      label:
-        add:
-          - do not merge
-
+  # Conflict in the PR - needs: work and a comment to notify a user
   - name: "label needs: work when there is a conflict"
     conditions:
       - conflict
@@ -128,6 +113,7 @@ pull_request_rules:
         add:
           - "release-version: feature branch"
 
+  # Ready for integration. Not yet auto merge, will be enabled once carefuly tested
   - name: label "ready for merge" when ready
     conditions:
       # Labels
@@ -151,3 +137,21 @@ pull_request_rules:
         remove: 
           - "needs: CI"
 
+  # Clean-up after merge
+  - name: remove ready for merge when merged
+    conditions:
+      - merged
+      - label=ready for merge
+    actions:
+      label:
+        remove:
+          - ready for merge
+
+  - name: add "do not merge" label when WIP is in title
+    conditions:
+       - title~=^(\[wip\]( |:) |\[WIP\]( |:) |wip( |:) |WIP( |:)).*
+    actions:
+      label:
+        add:
+          - do not merge
+