screwdriver-data-schema 26.0.0 → 26.1.1

package/migrations/20240906-add-templateId-and-archive-index-to-jobs.js

@@ -9,8 +9,7 @@ module.exports = {
     // eslint-disable-next-line no-unused-vars
     up: async (queryInterface, Sequelize) => {
         await queryInterface.sequelize.transaction(async transaction => {
-            await queryInterface.removeIndex(table, `${table}_templateId`, { transaction });
-
+            await queryInterface.removeIndex(table, `${table}_template_id`, { transaction });
             await queryInterface.addIndex(table, {
                 name: `${table}_templateId_archived`,
                 fields: ['templateId', 'archived'],

package/migrations/20260312000000-add-stateChanger-columns-to-pipeline.js

@@ -0,0 +1,37 @@
+/* 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,
+                'stateChanger',
+                {
+                    type: Sequelize.STRING(128)
+                },
+                { transaction }
+            );
+            await queryInterface.addColumn(
+                table,
+                'stateChangeTime',
+                {
+                    type: Sequelize.STRING(32)
+                },
+                { transaction }
+            );
+            await queryInterface.addColumn(
+                table,
+                'stateChangeMessage',
+                {
+                    type: Sequelize.STRING(512)
+                },
+                { transaction }
+            );
+        });
+    }
+};

package/models/pipeline.js

@@ -10,7 +10,8 @@ const WorkflowGraph = require('../config/workflowGraph');
 const Parameters = require('../config/parameters');
 const mutate = require('../lib/mutate');
 
-const STATES = ['ACTIVE', 'INACTIVE', 'DELETING'];
+const STATES = ['ACTIVE', 'INACTIVE', 'DELETING', 'DISABLED'];
+const VALID_STATES_FOR_UPDATE = ['ACTIVE', 'DISABLED'];
 const BADGE = Joi.object({
     defaultName: Joi.string()
         .max(128)
@@ -107,6 +108,15 @@ const MODEL = {
         .default('ACTIVE')
         .required(),
 
+    stateChanger: Joi.string().max(128).description('Username for who changed the state'),
+
+    stateChangeTime: Joi.string().isoDate().description('When the state of the pipeline was changed'),
+
+    stateChangeMessage: Joi.string()
+        .max(512)
+        .description('Reason why disabling or enabling pipeline')
+        .example('Disabling pipeline for maintenance'),
+
     subscribedScmUrlsWithActions: Joi.array()
         .items(
             Joi.object().keys({
@@ -132,7 +142,18 @@ const MODEL = {
         .allow(null)
 };
 
-const UPDATE_MODEL = { ...CREATE_MODEL, settings: MODEL.settings, badges: MODEL.badges };
+const UPDATE_MODEL = {
+    ...CREATE_MODEL,
+    settings: MODEL.settings,
+    badges: MODEL.badges,
+    state: Joi.string()
+        .valid(...VALID_STATES_FOR_UPDATE)
+        .max(10)
+        .description('New state of the pipeline')
+        .example('ACTIVE')
+        .optional(),
+    stateChangeMessage: MODEL.stateChangeMessage
+};
 
 module.exports = {
     /**
@@ -175,7 +196,10 @@ module.exports = {
                 'settings',
                 'badges',
                 'templateVersionId',
-                'adminUserIds'
+                'adminUserIds',
+                'stateChanger',
+                'stateChangeTime',
+                'stateChangeMessage'
             ]
         )
     ).label('Get Pipeline'),
@@ -197,7 +221,11 @@ module.exports = {
      * @type {Joi}
      */
     update: Joi.object(
-        mutate(UPDATE_MODEL, [], ['checkoutUrl', 'rootDir', 'autoKeysGeneration', 'settings', 'badges'])
+        mutate(
+            UPDATE_MODEL,
+            [],
+            ['checkoutUrl', 'rootDir', 'autoKeysGeneration', 'settings', 'badges', 'state', 'stateChangeMessage']
+        )
     ).label('Update Pipeline'),
 
     /**

package/package.json

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