📚 Add Guideline for removing ci-job from workflow pr-merge.yml

[ckunki]

Summary

Add a comment into the file and/or guideline to the User Guide for removing ci-job from workflow pr-merge.yml.

Details

PTB provides a template for GitHub Workflow pr-merge.yml.

This workflow is triggered on a push onto main branch and executes the tests, publishes the documentation, and reports metrics.

Executing the tests can take a significant amount of time, hence users might be interested to skip this job in the workflow since the tests already have been executed successfully on the branch that should be merged to main.

On the other hand, in some circumstances these tests might be the last or even only chance to detect problems.

The current ticket therefore requests to add a comment into the file and/or guideline to the User Guide for removing ci-job from workflow pr-merge.yml.

Of specific interest are

• dependencies to main branch of other git repositories (instead of proper dependencies to pypi packages in a specific version)
• long duration between finishing tests in the context of a PR on a branch and merging it to main
• Lack of properly configured GitHub branch protection for branch main

Background & Context

References

Task(s)