polaris.Task.add_step

Task.add_step(step=None, subdir=None, symlink=None, run_by_default=True)[source]

Add a step to the task and component (if not already present)

Parameters
  • step (polaris.Step, optional) – The step to add if adding by Step object, not subdirectory

  • subdir (str, optional) – The subdirectory of the step within the component if wish to add the step by path, and it has already been added to the component

  • symlink (str, optional) – A location for a symlink to the step, relative to the test case’s work directory. This is typically used for a shared step that lives outside of the test case

  • run_by_default (bool, optional) – Whether to add this step to the list of steps to run when the run() method gets called. If run_by_default=False, users would need to run this step manually.