redhat-developer / redhat-developer/vscode-openshift-tools

Create a view to set odo preferences

Open
#1,537 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

demo kind/feature priority/major
Dominant language
TypeScript
Stars
123
Forks
63
Avg merge
6h 16m
Merged PRs (30d)
74

Description

$odo preference -h

Modifies odo specific configuration settings within the global preference file.
Available Parameters:
Experimental - Set this value to true to expose features in development/experimental mode
NamePrefix - Use this value to set a default name prefix (Default: current directory name)
PushTarget - Set this value to 'kube' or 'docker' to tell odo where to push applications to. (Default: kube)
PushTimeout - PushTimeout (in seconds) for waiting for a Pod to come up (Default: 240)
Timeout - Timeout (in seconds) for OpenShift server connection check (Default: 1)
UpdateNotification - Flag to control if an update notification is shown or not (Default: true)
Usage:
  odo preference [flags]
  odo preference [command]
Examples:
  # For viewing the current local preference
  odo preference view
  # For viewing the current global preference
  odo preference view
  # Set a preference value in the global preference
  odo preference set UpdateNotification false
  odo preference set NamePrefix "app"
  odo preference set Timeout 20
  odo preference set PushTimeout 30
  odo preference set Experimental true
  odo preference set PushTarget docker
  # Unset a preference value in the global preference
  odo preference unset UpdateNotification
  odo preference unset NamePrefix
  odo preference unset Timeout
  odo preference unset PushTimeout
  odo preference unset Experimental
  odo preference unset PushTarget
Available Commands:
  set         Set a value in odo config file
  unset       Unset a value in odo preference file
  view        View current preference values

odo should also provide the way to get information about available preferences and preference types.
Upstream issue https://github.com/openshift/odo/issues/3094.

First implementation can be based on static list based on what -h command prints out.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the VS Code extension exposes odo commands and views, then compare that entry point with the preference names and types listed in the issue. The work is done when users can view the available odo preferences and their types and set the supported values through the new view.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.