<commit_before>.. only:: not (epub or latex or html)

    WARNING: You are looking at unreleased Cilium documentation.
    Please use the official rendered version released here:
    https://docs.cilium.io

.. _backport_process:

Backporting process
===================

.. _backport_criteria:

Backport Criteria
-----------------

Committers may nominate PRs that have been merged into master as candidates for
backport into stable releases if they affect the stable production usage
of community users.

Backport Criteria for Current Minor Release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Criteria for inclusion into the next stable release of the current latest
minor version of Cilium, for example in a ``v1.2.z`` release prior to the
release of version ``v1.3.0``:

- All bugfixes

Backport Criteria for X.Y-1.Z and X.Y-2.Z
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Criteria for the inclusion into the next stable release of the prior two minor
versions of Cilium, for example in a ``v1.0.z`` or ``v1.1.z`` release prior to
the release of version ``v1.3.0``:

- Security relevant fixes
- Major bugfixes relevant to the correct operation of Cilium


Backporting Guide for the Backporter
------------------------------------

Cilium PRs that are marked with the label ``needs-backport/X.Y`` need to be
backported to the stable branch ``X.Y``. The following steps summarize the
process for backporting these PRs:

* One-time setup
* Preparing PRs for backport
* Cherry-picking commits into a backport branch
* Posting the PR and updating GitHub labels

.. _backport_setup:

One-time Setup
~~~~~~~~~~~~~~

#. The scripts referred to below need to be run on Linux, they do not
   work on macOS. You can use the cilium dev VM for this, but you need
   to configure git to have your name and email address to be used in
   the commit messages:

   .. code-block:: bash

      $ git config --global user.name "<NAME>"
      $ git config --global user.email <EMAIL>

#. Make sure you have a GitHub developer access token with the ``public_repos``
   scope available. You can do this directly from
   https://github.com/settings/tokens or by opening GitHub and then navigating
   to: User Profile -> Settings -> Developer Settings -> Personal access token
   -> Generate new token.

#. This guide makes use of several tools to automate the backporting process.<commit_msg>backporting: Update instructions for backporting workflow<commit_after>.. only:: not (epub or latex or html)

    WARNING: You are looking at unreleased Cilium documentation.
    Please use the official rendered version released here:
    https://docs.cilium.io

.. _backport_process:

Backporting process
===================

.. _backport_criteria:

Backport Criteria
-----------------

Committers may nominate PRs that have been merged into master as candidates for
backport into stable releases if they affect the stable production usage
of community users.

Backport Criteria for Current Minor Release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Criteria for inclusion into the next stable release of the current latest
minor version of Cilium, for example in a ``v1.2.z`` release prior to the
release of version ``v1.3.0``:

- All bugfixes

Backport Criteria for X.Y-1.Z and X.Y-2.Z
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Criteria for the inclusion into the next stable release of the prior two minor
versions of Cilium, for example in a ``v1.0.z`` or ``v1.1.z`` release prior to
the release of version ``v1.3.0``:

- Security relevant fixes
- Major bugfixes relevant to the correct operation of Cilium


Backporting Guide for the Backporter
------------------------------------

Cilium PRs that are marked with the label ``needs-backport/X.Y`` need to be
backported to the stable branch ``X.Y``. The following steps summarize the
process for backporting these PRs:

* One-time setup
* Preparing PRs for backport
* Cherry-picking commits into a backport branch
* Posting the PR and updating GitHub labels

.. _backport_setup:

One-time Setup
~~~~~~~~~~~~~~

#. The scripts referred to below need to be run on Linux, they do not
   work on macOS. You can use the cilium dev VM for this, but you need
   to configure git to have your name and email address to be used in
   the commit messages:

   .. code-block:: bash

      $ git config --global user.name "<NAME>"
      $ git config --global user.email <EMAIL>

#. Add remotes for the Cilium upstream repository and your Cilium repository fork.

   .. code-block:: bash

      $ git remote add johndoe <EMAIL>:johndoe/cilium.git
      $ git remote add upstream https://github.com/cilium/cilium.git

#. Make sure you have a GitHub developer access token with the ``public_repos``
   ``workflow`` scopes available. You can do this directly from
   https://github.com/settings/tokens or by opening GitHub and then navigating
   to: User Profile -> Settings -> Developer Settings -> Personal access token
   -> Generate new token.

#. This guide makes use of several tools to automate the backporting process.
{'fraction_non_alphanumeric': 0.1291923000595356, 'fraction_numerical': 0.005556658067076801, 'mean_word_length': 3.5161290322580645, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 16, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2759806', 'n_tokens_mistral': 1384, 'n_tokens_neox': 1320, 'n_words': 649}