From 6989264963d1f8871404889243d2f15de198ee42 Mon Sep 17 00:00:00 2001 From: Stas Bekman Date: Thu, 15 Jul 2021 16:18:56 -0700 Subject: [PATCH] [doc] testing: how to trigger a self-push workflow (#12724) * [testing] details of how to start self-push workflow * style * fix * Apply suggestions from code review Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> --- docs/source/testing.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/source/testing.rst b/docs/source/testing.rst index 68da03bfa9..a3c8f847aa 100644 --- a/docs/source/testing.rst +++ b/docs/source/testing.rst @@ -1170,6 +1170,23 @@ To start a debugger at the point of the warning, do this: pytest tests/test_logging.py -W error::UserWarning --pdb +Working with github actions workflows +----------------------------------------------------------------------------------------------------------------------- + +To trigger a self-push workflow CI job, you must: + +1. Create a new branch on ``transformers`` origin (not a fork!). +2. The branch name has to start with either ``ci_`` or ``ci-`` (``master`` triggers it too, but we can't do PRs on + ``master``). It also gets triggered only for specific paths - you can find the up-to-date definition in case it + changed since this document has been written `here + `__ under `push:` +3. Create a PR from this branch. +4. Then you can see the job appear `here + `__. It may not run right away if there + is a backlog. + + + Testing Experimental CI Features -----------------------------------------------------------------------------------------------------------------------