diff --git a/dev/404.html b/dev/404.html index 52d2d9b6d2..33395ee086 100644 --- a/dev/404.html +++ b/dev/404.html @@ -3737,6 +3737,20 @@ You're not viewing the latest version. +
  • + + Backporting + +
    • + + + + + + + + +
  • Help Wanted diff --git a/dev/community/contribute/checks/overview/index.html b/dev/community/contribute/checks/overview/index.html index 26bdedc426..0b80470a8c 100644 --- a/dev/community/contribute/checks/overview/index.html +++ b/dev/community/contribute/checks/overview/index.html @@ -3874,6 +3874,20 @@ You're not viewing the latest version. +
  • + + Backporting + +
    • + + + + + + + + +
  • Help Wanted diff --git a/dev/community/contribute/checks/service-support/index.html b/dev/community/contribute/checks/service-support/index.html index 1cff4098ab..1edf7156dd 100644 --- a/dev/community/contribute/checks/service-support/index.html +++ b/dev/community/contribute/checks/service-support/index.html @@ -3825,6 +3825,20 @@ You're not viewing the latest version. +
  • + + Backporting + +
    • + + + + + + + + +
  • Help Wanted diff --git a/dev/community/contribute/discussion/index.html b/dev/community/contribute/discussion/index.html index 107fe41334..c6010a62a4 100644 --- a/dev/community/contribute/discussion/index.html +++ b/dev/community/contribute/discussion/index.html @@ -3818,6 +3818,20 @@ You're not viewing the latest version. +
  • + + Backporting + +
    • + + + + + + + + +
  • Help Wanted diff --git a/dev/community/contribute/issue/index.html b/dev/community/contribute/issue/index.html index f5eb07b127..cad1044edd 100644 --- a/dev/community/contribute/issue/index.html +++ b/dev/community/contribute/issue/index.html @@ -3760,6 +3760,20 @@ You're not viewing the latest version. +
  • + + Backporting + +
    • + + + + + + + + +
  • Help Wanted diff --git a/dev/community/contribute/pr/index.html b/dev/community/contribute/pr/index.html index 1c94b5996f..92d224ae50 100644 --- a/dev/community/contribute/pr/index.html +++ b/dev/community/contribute/pr/index.html @@ -3869,6 +3869,20 @@ You're not viewing the latest version. +
  • + + Backporting + +
    • + + + + + + + + +
  • Help Wanted diff --git a/dev/community/maintainer/backporting/index.html b/dev/community/maintainer/backporting/index.html new file mode 100644 index 0000000000..cee7f0760e --- /dev/null +++ b/dev/community/maintainer/backporting/index.html @@ -0,0 +1,4102 @@ + + + + + + + + + + + + + + + + + + + + Backporting - Trivy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + + + + + + +
    + +
    + + + + +
    +
    + + + +
    +
    +
    + + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    + + + + + + + + +

    Backporting Process

    +

    This document outlines the backporting process for Trivy, including when to create patch releases and how to perform the backporting.

    +

    When to Create Patch Releases

    +

    In general, small changes should not be backported and should be included in the next minor release. +However, patch releases should be made in the following cases:

    +
      +
    • Fixes for HIGH or CRITICAL vulnerabilities in Trivy itself or Trivy's dependencies
      • +
    • Fixes for bugs that cause panic during Trivy execution or otherwise interfere with normal usage
      • +
    +

    In these cases, the fixes should be backported using the procedure described below. +At the maintainer's discretion, other bug fixes may be included in the patch release containing these hotfixes.

    +

    Versioning

    +

    Trivy follows Semantic Versioning, using version numbers in the format MAJOR.MINOR.PATCH. +When creating a patch release, the PATCH part of the version number is incremented. +For example, if a fix is being distributed for v0.50.0, the patch release would be v0.50.1.

    +

    Backporting Procedure

    +
      +
    1. A release branch (e.g., release/v0.50) is automatically created when a new minor version is released.
      2. +
    2. Create a pull request (PR) against the main branch with the necessary fixes. If the fixes are already merged into the main branch, skip this step.
      3. +
    3. Once the PR with the fixes is merged, comment @aqua-bot backport <release-branch> on the PR (e.g., @aqua-bot backport release/v0.50). This will trigger the automated backporting process using GitHub Actions.
      4. +
    4. The automated process will create a new PR with the backported changes. Ensure that all tests pass for this PR.
      5. +
    5. Once the tests pass, merge the automatically created PR into the release branch.
      6. +
    6. Merge a release PR on the release branch and release the patch version.
      7. +
    +
    +

    Note

    +

    Even if a conflict occurs, a PR is created by forceful commit, in which case the conflict should be resolved manually. +If you want to re-run a backport of the same PR, close the existing PR, delete the branch and re-run it.

    +
    +

    Example

    +

    To better understand the backporting procedure, let's walk through an example using the releases of v0.50.

    +
    gitGraph:
+  commit id:"Feature 1"
+  commit id:"v0.50.0 release" tag:"v0.50.0"
+
+  branch "release/v0.50"
+
+  checkout main
+  commit id:"Bugfix 1"
+
+  checkout "release/v0.50"
+  cherry-pick id:"Bugfix 1"
+
+  checkout main
+  commit id:"Feature 2"
+  commit id:"Bugfix 2"
+  commit id:"Feature 3"
+
+  checkout "release/v0.50"
+  cherry-pick id:"Bugfix 2"
+  commit id:"v0.50.1 release" tag:"v0.50.1"
    + + +
    + + + +
    +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/dev/community/maintainer/help-wanted/index.html b/dev/community/maintainer/help-wanted/index.html index 65ac47043e..cdeefa5183 100644 --- a/dev/community/maintainer/help-wanted/index.html +++ b/dev/community/maintainer/help-wanted/index.html @@ -3749,6 +3749,20 @@ You're not viewing the latest version. + +
  • + + Backporting + +
    • + + + + + + + + @@ -3978,7 +3992,7 @@ labels (above) in addition to meeting the following criteria: