Merge pull request #55703 from michaelryanpeter/osdocs-5181-osdk-add-osdk-version-to-common-attributes

OSDOCS#5181: Add OSDK version to common attributes and clean up

Author: michaelryanpeter

_attributes/common-attributes.adoc

@@ -162,4 +162,8 @@ endif::[]
 //endif::[]
 // logical volume manager storage
 :lvms-first: Logical volume manager storage (LVM Storage)
-:lvms: LVM Storage
+:lvms: LVM Storage
+//Operator SDK version
+:osdk_ver: 1.25.4
+//Operator SDK version that shipped with the previous OCP 4.x release
+:osdk_ver_n1: 1.22.0

modules/osdk-updating-projects.adoc renamed to _unused_topics/osdk-updating-projects.adoc

@@ -33,7 +33,7 @@ where:
 
 <bundle_registry>:: Specifies the registry where the bundle is hosted, such as `quay.io/example`.
 <bundle_image_name>:: Specifies the name of the bundle image, such as `memcached-operator`.
-<tag>:: Specifies the tag of the bundle image, such as `v1.22.0`.
+<tag>:: Specifies the tag of the bundle image, such as `v{osdk_ver}`.
 +
 [NOTE]
 ====
@@ -51,7 +51,7 @@ $ operator-sdk bundle validate \
 +
 where:
 
-<bundle_dir_or_image>:: Specifies the local bundle directory or remote bundle image, such as `~/projects/memcached` or `quay.io/example/memcached-operator:v1.22`.
+<bundle_dir_or_image>:: Specifies the local bundle directory or remote bundle image, such as `~/projects/memcached` or `quay.io/example/memcached-operator:v{osdk_ver}`.
 <test_label>:: Specifies the name of the validator you want to run, such as `name=good-practices`.
 +
 .Example output

modules/osdk-updating-v1101-to-v1160.adoc renamed to _unused_topics/osdk-updating-v1101-to-v1160.adoc

@@ -3,8 +3,6 @@
 // * cli_reference/osdk/cli-osdk-install.adoc
 // * operators/operator_sdk/osdk-installing-cli.adoc
 
-:osdk_ver: v1.25.4
-
 :_content-type: PROCEDURE
 [id="osdk-installing-cli-linux-macos_{context}"]
 = Installing the Operator SDK CLI
@@ -31,7 +29,7 @@ endif::[]
 +
 [source,terminal,subs="attributes+"]
 ----
-$ tar xvf operator-sdk-{osdk_ver}-ocp-linux-x86_64.tar.gz
+$ tar xvf operator-sdk-v{osdk_ver}-ocp-linux-x86_64.tar.gz
 ----
 
 . Make the file executable:
@@ -70,7 +68,5 @@ $ operator-sdk version
 .Example output
 [source,terminal,subs="attributes+"]
 ----
-operator-sdk version: "{osdk_ver}-ocp", ...
+operator-sdk version: "v{osdk_ver}-ocp", ...
 ----
-
-:!osdk_ver:

modules/osdk-upgrading-v180-to-v1101.adoc renamed to _unused_topics/osdk-upgrading-v180-to-v1101.adoc

@@ -2,8 +2,6 @@
 //
 // * operators/operator_sdk/osdk-scorecard.adoc
 
-:osdk_ver: v1.25.4
-
 [id="osdk-scorecard-config_{context}"]
 = Scorecard configuration
 
@@ -28,14 +26,14 @@ metadata:
 stages:
 - parallel: true
   tests:
-  - image: quay.io/operator-framework/scorecard-test:{osdk_ver}
+  - image: quay.io/operator-framework/scorecard-test:v{osdk_ver}
     entrypoint:
     - scorecard-test
     - basic-check-spec
     labels:
       suite: basic
       test: basic-check-spec-test
-  - image: quay.io/operator-framework/scorecard-test:{osdk_ver}
+  - image: quay.io/operator-framework/scorecard-test:v{osdk_ver}
     entrypoint:
     - scorecard-test
     - olm-bundle-validation
@@ -61,4 +59,3 @@ following fields of the scorecard configuration file define the test as follows:
 |Scorecard-defined or custom labels that select which tests to run
 |===
 
-:!osdk_ver:

modules/osdk-bundle-validate-run.adoc

@@ -2,8 +2,6 @@
 //
 // * operators/operator_sdk/osdk-scorecard.adoc
 
-:osdk_ver: v1.25.4
-
 [id="osdk-scorecard-output_{context}"]
 = Scorecard output
 
@@ -22,7 +20,7 @@ The `--output` flag for the `scorecard` command specifies the scorecard results
       "kind": "Test",
       "apiVersion": "scorecard.operatorframework.io/v1alpha3",
       "spec": {
-        "image": "quay.io/operator-framework/scorecard-test:{osdk_ver}",
+        "image": "quay.io/operator-framework/scorecard-test:v{osdk_ver}",
         "entrypoint": [
           "scorecard-test",
           "olm-bundle-validation"
@@ -53,7 +51,7 @@ The `--output` flag for the `scorecard` command specifies the scorecard results
 [source,text,subs="attributes+"]
 ----
 --------------------------------------------------------------------------------
-Image:      quay.io/operator-framework/scorecard-test:{osdk_ver}
+Image:      quay.io/operator-framework/scorecard-test:v{osdk_ver}
 Entrypoint: [scorecard-test olm-bundle-validation]
 Labels:
 	"suite":"olm"
@@ -74,5 +72,3 @@ Results:
 ====
 The output format spec matches the link:https://pkg.go.dev/github.com/operator-framework/api/pkg/apis/scorecard/v1alpha3#Test[`Test`] type layout.
 ====
-
-:!osdk_ver:

modules/osdk-installing-cli-linux-macos.adoc

@@ -2,8 +2,6 @@
 //
 // * operators/operator_sdk/osdk-scorecard.adoc
 
-:osdk_ver: v1.25.4
-
 :_content-type: PROCEDURE
 [id="osdk-scorecard-parallel_{context}"]
 = Enabling parallel testing
@@ -30,14 +28,14 @@ stages:
   - entrypoint:
     - scorecard-test
     - basic-check-spec
-    image: quay.io/operator-framework/scorecard-test:{osdk_ver}
+    image: quay.io/operator-framework/scorecard-test:v{osdk_ver}
     labels:
       suite: basic
       test: basic-check-spec-test
   - entrypoint:
     - scorecard-test
     - olm-bundle-validation
-    image: quay.io/operator-framework/scorecard-test:{osdk_ver}
+    image: quay.io/operator-framework/scorecard-test:v{osdk_ver}
     labels:
       suite: olm
       test: olm-bundle-validation-test
@@ -46,4 +44,3 @@ stages:
 +
 All tests in a parallel stage are executed simultaneously, and scorecard waits for all of them to finish before proceding to the next stage. This can make your tests run much faster.
 
-:!osdk_ver:

modules/osdk-scorecard-config.adoc

@@ -27,9 +27,6 @@ ifeval::["{context}" == "osdk-java-updating-projects"]
 :type: Java
 endif::[]
 
-:osdk_ver: v1.25.4
-:osdk_ver_n1: v1.22.0
-
 :_content-type: PROCEDURE
 [id="osdk-upgrading-projects_{context}"]
 = Updating {type}-based Operator projects for Operator SDK {osdk_ver}
@@ -312,9 +309,6 @@ $ go mod tidy
 ----
 endif::[]
 
-:!osdk_ver:
-:!osdk_ver_n1:
-
 ifeval::["{context}" == "osdk-golang-updating-projects"]
 :!golang:
 :!type: