feat(2331): Expand step object for job validation [1] #437
Conversation
This file contains 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
jithine
reviewed
Feb 12, 2021
| module.exports = { | ||
| up: async (queryInterface, Sequelize) => { | ||
| await queryInterface.sequelize.transaction(async (transaction) => { | ||
| await queryInterface.addColumn(table, 'locked', { |
There was a problem hiding this comment.
will be we adding individual columns for use cases like retry, continue on error ?
There was a problem hiding this comment.
I think that's better for validation and quicker lookup
There was a problem hiding this comment.
but for template key probably don't need that actually
tkyi
changed the title
tkyi
changed the title
jithine
reviewed
Feb 16, 2021
| // Template steps | ||
| const SCHEMA_TEMPLATE_STEP_SUBOBJECT = SCHEMA_STEP_SUBOBJECT_BASE | ||
| .keys({ | ||
| locked: Joi.boolean() |
There was a problem hiding this comment.
should this be optional ? should we allow users to define the step object format without any attributes ?
There was a problem hiding this comment.
I think it's okay
the template-validator/config-parser can convert the non-attribute step objects to the simplified version
jithine
approved these changes
Feb 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
It would be nice if template owners could indicate which steps cannot be overwritten in their templates. In order to allow for this change (and other step expansions), it would be nice if steps can be expanded to more than just a string or single key-value object.
Objective
This PR adds the option to expand step object from previous formats
'npm publish'/{ deploy: npm publish }to allow for more complex objects{ deploy: { command: 'npm publish', locked: true } }.Also adds
lockedfield to step.References
Related to screwdriver-cd/screwdriver#2331
License
I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.