sigs.k8s.io/kubebuilder/v3@v3.14.0/VERSIONING.md (about)

     1  # Versioning and Releasing for Kubebuilder
     2  
     3  We (mostly) follow the [common Kubebuilder versioning
     4  guidelines][guidelines], and use the corresponding tooling and PR process
     5  described there.
     6  
     7  For the purposes of the aforementioned guidelines, Kubebuilder counts as
     8  a "CLI project".
     9  
    10  [guidelines]: https://sigs.k8s.io/kubebuilder-release-tools/VERSIONING.md
    11  
    12  ## Compatibility
    13  
    14  Note that we generally do not support older release branches, except in
    15  extreme circumstances.
    16  
    17  Bear in mind that changes to scaffolding generally constitute breaking
    18  changes -- see [below](#understanding-the-versions) for more details.
    19  
    20  ## Releasing
    21  
    22  When releasing, you'll need to:
    23  
    24  - to update references in [the build directory](build/) to the latest
    25    version of the [envtest tools](#tools-releases) **before tagging the
    26    release.**
    27  
    28  - reset the book branch: see [below](#book-releases)
    29  
    30  You may also want to check that the book is generating the marker docs off
    31  the latest controller-tools release.  That info is stored in
    32  [docs/book/install-and-build.sh](/docs/book/install-and-build.sh).
    33  
    34  ## Book Releases
    35  
    36  The book's main version (https://book.kubebuilder.io) is published off of
    37  the [book-v3][book-branch] (a version built off the main branch can be
    38  found at https://master.book.kubebuilder.io).
    39  
    40  Docs changes that aren't specific to a new feature should be
    41  cherry-picked to the aforementioned branch to get them to be published.
    42  The cherry-picks will automatically be published to the book once their PR
    43  merges.
    44  
    45  **When you publish a Kubebuilder release**, be sure to also submit a PR
    46  that merges the main branch into [book-v3][book-branch], so that it
    47  describes the latest changes in the new release.
    48  
    49  [book-branch]: https://github.com/kubernetes-sigs/kubebuilder/tree/tools-releases
    50  
    51  ## Tools Releases
    52  
    53  In order to update the [envtest tools][envtest-ref], you'll need to do an
    54  update to the [tools-releases branch][tools-branch].  Simply submit a PR
    55  against that branch that changes all references to the current version to
    56  the desired next version.  Once the PR is merged, Google Cloud Build will
    57  take care of building and publishing the artifacts.
    58  
    59  [envtest-ref]: https://book.kubebuilder.io/reference/artifacts.html
    60  [tools-branch]: https://github.com/kubernetes-sigs/kubebuilder/tree/tools-releases
    61  [kb-releases]:https://github.com/kubernetes-sigs/kubebuilder/releases
    62  [cli-plugins-versioning]:docs/book/src/plugins/extending-cli.md#plugin-versioning