screwdriver-data-schema 22.11.1 → 23.0.0

package/config/base.js

@@ -63,7 +63,30 @@ const SCHEMA_SUBSCRIBE = Joi.object().keys({
     )
 });
 
-const SCHEMA_CONFIG = Joi.object()
+const SCHEMA_CONFIG_PRE_TEMPLATE_MERGE = Joi.object()
+    .keys({
+        template: Joi.string().regex(Regex.FULL_TEMPLATE_NAME_WITH_NAMESPACE),
+        version: Joi.number().integer().min(1).max(50),
+        annotations: Annotations.annotations.when('template', { is: Joi.exist(), then: Joi.forbidden() }),
+        jobs: SCHEMA_JOBS.when('template', { is: Joi.exist(), then: Joi.forbidden(), otherwise: Joi.required() }),
+        shared: Joi.when('template', {
+            is: Joi.exist(),
+            then: Joi.object().keys({
+                image: Job.image,
+                environment: Job.environment,
+                settings: Job.settings
+            }),
+            otherwise: SCHEMA_SHARED
+        }),
+        cache: SCHEMA_CACHE.when('template', { is: Joi.exist(), then: Joi.forbidden() }),
+        childPipelines: SCHEMA_CHILD_PIPELINES.when('template', { is: Joi.exist(), then: Joi.forbidden() }),
+        stages: SCHEMA_STAGES.when('template', { is: Joi.exist(), then: Joi.forbidden() }),
+        subscribe: SCHEMA_SUBSCRIBE.when('template', { is: Joi.exist(), then: Joi.forbidden() }),
+        parameters: Parameters.parameters.default({}).when('template', { is: Joi.exist(), then: Joi.forbidden() })
+    })
+    .unknown(false);
+
+const SCHEMA_CONFIG_POST_TEMPLATE_MERGE = Joi.object()
     .keys({
         version: Joi.number().integer().min(1).max(50),
         annotations: Annotations.annotations,
@@ -73,7 +96,8 @@ const SCHEMA_CONFIG = Joi.object()
         childPipelines: SCHEMA_CHILD_PIPELINES,
         stages: SCHEMA_STAGES,
         subscribe: SCHEMA_SUBSCRIBE,
-        parameters: Parameters.parameters.default({})
+        parameters: Parameters.parameters.default({}),
+        templateVersionId: Joi.number().integer().positive().optional().allow(null)
     })
     .unknown(false);
 
@@ -88,7 +112,8 @@ module.exports = {
     cache: SCHEMA_CACHE,
     cachePerm: SCHEMA_CACHE_PERMUTATION,
     childPipelines: SCHEMA_CHILD_PIPELINES,
-    config: SCHEMA_CONFIG,
+    configBeforeMergingTemplate: SCHEMA_CONFIG_PRE_TEMPLATE_MERGE,
+    configAfterMergingTemplate: SCHEMA_CONFIG_POST_TEMPLATE_MERGE,
     stageSetupTeardownJob: SCHEMA_SETUP_TEARDOWN_JOB,
     stage: SCHEMA_STAGE,
     stages: SCHEMA_STAGES,

package/migrations/20240228-add_column_templateVersionId_to_pipeline.JS

@@ -0,0 +1,27 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}pipelines`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.addColumn(
+                table,
+                'templateVersionId',
+                {
+                    type: Sequelize.INTEGER.UNSIGNED
+                },
+                { transaction }
+            );
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_template_version_id`,
+                fields: ['templateVersionId'],
+                transaction
+            });
+        });
+    }
+};

package/models/pipeline.js

@@ -112,7 +112,15 @@ const MODEL = {
     })
         .description('A list of badges that pipline has')
         .example(`{ sonar: { name: 'dashboard', uri: 'http://sonar.com/sample1' } }`)
+        .optional(),
+
+    templateVersionId: Joi.number()
+        .integer()
+        .positive()
+        .description("Identifier for this pipeline's template")
+        .example(123345)
         .optional()
+        .allow(null)
 };
 
 const UPDATE_MODEL = { ...CREATE_MODEL, settings: MODEL.settings, badges: MODEL.badges };
@@ -156,7 +164,8 @@ module.exports = {
                 'parameters',
                 'subscribedScmUrlsWithActions',
                 'settings',
-                'badges'
+                'badges',
+                'templateVersionId'
             ]
         )
     ).label('Get Pipeline'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "22.11.1",
+  "version": "23.0.0",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {