Skip to content

Allow projects to modify workflow templates with a YML #641

@ArBridgeman

Description

@ArBridgeman

Summary

We want to allow templates to be sanely modified by either having REPLACE or INSERT_AFTER actions like the project-keeper:

https://github.com/exasol/project-keeper/blob/main/doc/user_guide/user_guide.md#customize-workflow-environment

To Do

  • Create a defined YML format similar to that used in project-keeper:
    https://github.com/exasol/project-keeper/blob/main/doc/user_guide/user_guide.md#customize-workflow-environment
  • Define the filepath of this YML file as a default in the BaseConfig
  • Update the nox session workflows:update so that uses a function(s):
    • to load the YML & validate it has the correct structure
    • it verifies that the specified workflow template is part of the PTB templates. If it's not, raise an exception.
    • goes through the specified workflow template & searches for the id. If it's not found, raise an exception
    • if the id is found, perform the action specified REPLACE or INSERT_AFTER
  • Add tests to verify that all the parts work as expected and that the end result of a modified YML behaves as desired.
  • Modify user & developer guides, using project-keeper as inspiration to describe this new feature and common use cases (i.e. skipping docs).

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureProduct feature

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions