#204: Added a guideline for removing ci-job from workflow pr-merge.yml

doc/changes/unreleased.md

@@ -1 +1,6 @@
 # Unreleased
+
+
+## Doc
+
+* #204: Added a guideline for removing `ci-job` from workflow `pr-merge.yml`

doc/user_guide/workflows.rst

@@ -90,3 +90,16 @@ and add the following content:
 
 .. literalinclude:: ../../exasol/toolbox/templates/github/workflows/pr-merge.yml
     :language: yaml
+
+In order to make merging to the main branch faster you can skip running the
+tests again in this workflow.
+
+Before removing the ``ci-job`` from the workflow by please make sure the
+following prerequisites are met, as in some circumstances these tests might be
+the last or even only chance to detect problems.
+
+* GitHub branch protection for main branch is properly configured.
+* All dependencies are pointing to proper pypi packages in specific versions, i.e. no
+  dependencies to the main branch of other git repositories.
+* Development branches are short-lived and merged to main branch soon after
+  finishing tests in the context of a pull request.

exasol/toolbox/templates/github/workflows/pr-merge.yml

@@ -8,6 +8,9 @@ on:
 
 jobs:
 
+  # This job can be removed if certain preconditions are met. See
+  # https://exasol.github.io/python-toolbox/user_guide/workflows.html#pr-merge-workflow
+
   ci-job:
     name: Checks
     uses: ./.github/workflows/checks.yml