docs: add v1alpha1 to v1beta1 CR migration guide - #2307
Open
Ryntak94 wants to merge 1 commit into
Open
Conversation
Adds docs/migrating-v1alpha1-to-v1beta1.md, a spec-path oriented migration guide for users moving their Custom Resources from shipwright.io/v1alpha1 to shipwright.io/v1beta1, modelled on the Tekton Pipelines migration doc. The guide covers Build, BuildRun, BuildStrategy and ClusterBuildStrategy with per-resource mapping tables (v1alpha1 path, v1beta1 path, notes), the fields that were removed, the BuildRun status changes, the build strategy placeholder rewrites, and before/after YAML examples adapted from the samples in this repository. It also documents what the conversion webhook handles automatically versus what has to be changed by hand. Every mapping is derived from the conversion webhook implementations in pkg/apis/build/v1beta1/*_conversion.go and from the API type definitions, and the YAML examples were verified by running the conversion code over them. Closes shipwright-io#1377 Signed-off-by: Ryan Matthews <ryan.matthews.professional@gmail.com>
pull-request-size
Bot
added
the
size/L
openshift-ci
Bot
added
do-not-merge/work-in-progress
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Ryntak94
marked this pull request as ready for review
August 25, 2026 03:10
openshift-ci
Bot
removed
the
do-not-merge/work-in-progress
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Adds
docs/migrating-v1alpha1-to-v1beta1.md, a spec-path oriented migration guide for users moving their Custom Resources fromshipwright.io/v1alpha1toshipwright.io/v1beta1, modelled on the Tekton Pipelines migration doc that the issue points at.The guide covers
Build,BuildRun,BuildStrategyandClusterBuildStrategywith per-resource mapping tables (v1alpha1 path → v1beta1 path → notes), the fields that were removed, theBuildRunstatus changes, the build strategy placeholder rewrites, and before/after YAML examples adapted from the samples in this repository. It also documents what the conversion webhook handles automatically versus what has to be changed by hand.Every mapping is derived from the conversion webhook implementations in
pkg/apis/build/v1beta1/*_conversion.goand from the API type definitions, rather than from memory, and the YAML examples were checked by running the conversion code over them.docs/README.mdgains a link to the new page.Docs-only change; no Go code is touched.
Related Issue
Fixes #1377
Type of PR
/kind documentation
Submitter Checklist
Includes tests if functionality changed/was added— documentation onlyRelease Notes