Uploaded image for project: 'OpenShift Pipelines'
  1. OpenShift Pipelines
  2. SRVKP-10820

Update OpenShift Pipelines documentation to use tekton.dev/v1 API version

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      Summary

      The OpenShift Pipelines documentation in the openshift/openshift-docs repository contains references to tekton.dev/v1beta1 which should be updated to tekton.dev/v1.

      Tekton Pipelines v1 API has been stable since Tekton Pipelines v0.44.0 (released in early 2023). OpenShift Pipelines 1.10+ ships with Tekton Pipelines versions that fully support the v1 API. The v1beta1 API is deprecated and will eventually be removed.

      Scope

      31 files need to be updated.

      Core Concepts (8 files)

      * modules/op-about-tasks.adoc
      * modules/op-about-pipelines.adoc
      * modules/op-about-pipelinerun.adoc
      * modules/op-about-taskrun.adoc
      * modules/op-about-triggers.adoc
      * modules/op-about-workspace.adoc
      * modules/op-about-whenexpression.adoc
      * modules/op-about-finally_tasks.adoc

      Configuration (5 files)

      * modules/op-configuring-basic-authentication-for-git.adoc
      * modules/op-configuring-ssh-authentication-for-git.adoc
      * modules/op-configuring-buildah-to-use-build-user.adoc
      * modules/op-configuring-eventlisteners-to-serve-multiple-namespaces.adoc
      * modules/op-creating-pipeline-templates-admin-console.adoc

      Resolvers (4 files)

      * modules/op-resolver-bundle.adoc
      * modules/op-resolver-cluster.adoc
      * modules/op-resolver-git.adoc
      * modules/op-resolver-hub.adoc

      Other Pipelines Docs (10 files)

      * modules/op-adding-triggers.adoc
      * modules/op-assembling-a-pipeline.adoc
      * modules/op-authenticating-to-an-oci-registry.adoc
      * modules/op-filtering-pull-requests-using-GitHub-interceptor.adoc
      * modules/op-running-pipeline-run-and-task-run-with-custom-scc-and-service-account.adoc
      * modules/op-specifying-pipelines-resource-quota-using-priority-class.adoc
      * modules/op-starting-a-task-run-pipeline-run-build-user.adoc
      * modules/op-validating-pull-requests-using-GitHub-interceptors.adoc
      * modules/op-release-notes-1-8.adoc
      * modules/op-release-notes-1-11.adoc

      Jenkins Migration Guides (4 files)

      * modules/jt-examples-of-common-use-cases.adoc
      * modules/jt-extending-openshift-pipelines-capabilities-using-custom-tasks-and-scripts.adoc
      * modules/jt-migrating-a-sample-pipeline-from-jenkins-to-openshift-pipelines.adoc
      * modules/jt-migrating-from-jenkins-plugins-to-openshift-pipelines-hub-tasks.adoc

      Changes Required

      Update YAML examples: apiVersion: tekton.dev/v1beta1apiVersion: tekton.dev/v1

      Update callout notes: references to "v1beta1" → "v1"

      Update any descriptive text mentioning v1beta1 as the current API version

      Acceptance Criteria

      • All 31 files updated to use tekton.dev/v1 in YAML examples
      • All callout annotations updated to reference v1 instead of v1beta1
      • Documentation builds successfully
      • PR submitted to openshift/openshift-docs repository

      Repository

      [openshift/openshift-docs|https://github.com/openshift/openshift-docs]

              Unassigned Unassigned
              vdemeest Vincent Demeester
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: