From eccd2dd34ab8b84ea29ed4c9190155b660165f4c Mon Sep 17 00:00:00 2001 From: ckunki Date: Wed, 12 Jun 2024 10:49:06 +0200 Subject: [PATCH] #204: Added a guideline for removing ci-job from workflow pr-merge.yml --- doc/changes/unreleased.md | 5 +++++ doc/user_guide/workflows.rst | 13 +++++++++++++ .../toolbox/templates/github/workflows/pr-merge.yml | 3 +++ 3 files changed, 21 insertions(+) diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 79e701b84..b655fadd6 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -1 +1,6 @@ # Unreleased + + +## Doc + +* #204: Added a guideline for removing `ci-job` from workflow `pr-merge.yml` diff --git a/doc/user_guide/workflows.rst b/doc/user_guide/workflows.rst index a23e9ae04..89f8721ff 100644 --- a/doc/user_guide/workflows.rst +++ b/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. diff --git a/exasol/toolbox/templates/github/workflows/pr-merge.yml b/exasol/toolbox/templates/github/workflows/pr-merge.yml index 99139d684..e4be0103a 100644 --- a/exasol/toolbox/templates/github/workflows/pr-merge.yml +++ b/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