[Notes] [Git][BuildStream/buildstream][aevri/prompt-config] 3 commits: A

Angelos Evripiotis pushed to branch aevri/prompt-config at BuildStream / buildstream

Commits:

006cc16c

by Angelos Evripiotis at 2018-10-19T17:50:04Z

Add prompt.auto-init buildstream.conf option

Provide an option in buildstream.conf to disable the 'Would you like to
...' prompt when we cannot resolve a project.

Some users prefer not to be interrupted by such prompts, so pave the way
to creating options to disable all those that might get in the way.

Follow the example of the advice.* options 'git-config', and create a
namespace for these UI options grouped by behaviour, rather than an
over-reaching 'ui.*' namespace. In later work perhaps we'll also add
'advice.*' options.

Add a NEWS item for this.

25169849

by Angelos Evripiotis at 2018-10-19T17:50:42Z

Add prompt.option workspace-close-remove-dir

Provide an option in project.conf to disable the 'Are you sure ...'
prompt when we are removing a workspace directory.

Add a NEWS item for this.

70b661de

by Angelos Evripiotis at 2018-10-19T17:59:32Z

Add prompt.option workspace-reset-hard

Provide an option in project.conf to disable the 'Are you sure ...'
prompt when we are resetting a workspace.

Add a NEWS item for this.

Changes:

NEWS

@@ -31,6 +31,12 @@ buildstream 1.3.1
      new the `conf-root` variable to make the process easier. And there has been
      a bug fix to workspaces so they can be build in workspaces too.
 +  o The buildstream.conf file learned new 'prompt.auto-init',
 +    'prompt.workspace-close-remove-dir', and 'prompt.workspace-reset-hard'
 +    options. These allow users to suppress certain confirmation prompts, e.g.
 +    double-checking that the user meant to run the command as typed.
++
++
  =================
  buildstream 1.1.5
  =================

buildstream/_context.py

@@ -104,6 +104,18 @@ class Context():
          # What to do when a build fails in non interactive mode
          self.sched_error_action = 'continue'
 +        # Whether to offer to create a project for the user, if we are invoked
 +        # outside of a directory where we can resolve the project.
 +        self.prompt_auto_init = True
++
 +        # Whether we double-check with the user that they meant to remove a
 +        # workspace directory.
 +        self.workspace_close_remove_dir = True
++
 +        # Whether we double-check with the user that they meant to do a hard
 +        # reset of a workspace, potentially losing changes.
 +        self.workspace_reset_hard = True
++
          # Whether elements must be rebuilt when their dependencies have changed
          self._strict_build_plan = None
@@ -160,7 +172,7 @@ class Context():
          _yaml.node_validate(defaults, [
              'sourcedir', 'builddir', 'artifactdir', 'logdir',
              'scheduler', 'artifacts', 'logging', 'projects',
 -            'cache'
 +            'cache', 'prompt'
          ])
          for directory in ['sourcedir', 'builddir', 'artifactdir', 'logdir']:
@@ -212,6 +224,19 @@ class Context():
          self.sched_pushers = _yaml.node_get(scheduler, int, 'pushers')
          self.sched_network_retries = _yaml.node_get(scheduler, int, 'network-retries')
 +        # Load prompt preferences
 +        prompt = _yaml.node_get(
 +            defaults, Mapping, 'prompt')
 +        _yaml.node_validate(prompt, [
 +            'auto-init', 'workspace-close-remove-dir', 'workspace-reset-hard',
 +        ])
 +        self.prompt_auto_init = _yaml.node_get(
 +            prompt, bool, 'auto-init')
 +        self.workspace_close_remove_dir = _yaml.node_get(
 +            prompt, bool, 'workspace-close-remove-dir')
 +        self.workspace_reset_hard = _yaml.node_get(
 +            prompt, bool, 'workspace-reset-hard')
++
          # Load per-projects overrides
          self._project_overrides = _yaml.node_get(defaults, Mapping, 'projects', default_value={})

buildstream/_frontend/app.py

@@ -222,9 +222,10 @@ class App():
              # Let's automatically start a `bst init` session in this case
              if e.reason == LoadErrorReason.MISSING_PROJECT_CONF and self.interactive:
                  click.echo("A project was not detected in the directory: {}".format(directory), err=True)
 -                click.echo("", err=True)
 -                if click.confirm("Would you like to create a new project here ?"):
 -                    self.init_project(None)
 +                if self.context.prompt_auto_init:
 +                    click.echo("", err=True)
 +                    if click.confirm("Would you like to create a new project here?"):
 +                        self.init_project(None)
              self._error_exit(e, "Error loading project")

buildstream/_frontend/cli.py

@@ -743,7 +743,7 @@ def workspace_close(app, remove_dir, all_, elements):
          if nonexisting:
              raise AppError("Workspace does not exist", detail="\n".join(nonexisting))
 -        if app.interactive and remove_dir:
 +        if app.interactive and remove_dir and app.context.workspace_close_remove_dir:
              if not click.confirm('This will remove all your changes, are you sure?'):
                  click.echo('Aborting', err=True)
                  sys.exit(-1)
@@ -777,7 +777,7 @@ def workspace_reset(app, soft, track_, all_, elements):
          if all_ and not app.stream.workspace_exists():
              raise AppError("No open workspaces to reset")
 -        if app.interactive and not soft:
 +        if app.interactive and not soft and app.context.workspace_reset_hard:
              if not click.confirm('This will remove all your changes, are you sure?'):
                  click.echo('Aborting', err=True)
                  sys.exit(-1)

buildstream/data/userconfig.yaml

@@ -97,3 +97,19 @@ logging:
      [%{elapsed}][%{key}][%{element}] %{action} %{message}
 +#
 +# Prompts we may present to the user
 +#
++
 +prompt:
 +  # Whether to offer to create a project, if we are invoked outside of a
 +  # directory where we can resolve the project.
 +  auto-init: True
++
 +  # Whether we double-check with the user that they meant to remove a
 +  # workspace directory.
 +  workspace-close-remove-dir: True
++
 +  # Whether we double-check with the user that they meant to do a hard
 +  # reset of a workspace, potentially losing changes.
 +  workspace-reset-hard: True

[Notes] [Git][BuildStream/buildstream][aevri/prompt-config] 3 commits: Add prompt.auto-init buildstream.conf option

Angelos Evripiotis pushed to branch aevri/prompt-config at BuildStream / buildstream

Commits:

5 changed files:

Changes: