Skip to content

CL-8827 | Drop environment description from env:create, env:update and env:get - #295

Open
SakshiKoli-CS wants to merge 4 commits into
v2-devfrom
CL-8827
Open

SakshiKoli-CS wants to merge 4 commits into
v2-devfrom
CL-8827

Conversation

@SakshiKoli-CS

@SakshiKoli-CS SakshiKoli-CS commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Jira: CL-8827

What

The Launch UI never shows or edits an environment's description, and the CLI's handling of it was broken. env:update --description "" was treated as no flag: on its own it exited 2 with "none was supplied", and combined with other flags it was silently dropped. The interactive Description prompt couldn't clear a value either. Rather than fix a field only the CLI exposes, this PR removes it to match the UI.

  • launch:env:create and launch:env:update no longer accept --description. Passing it now fails with oclif's unknown-flag error (exit 2), and no description is sent to the API.

  • launch:env:update no longer lists --description in "Pass at least one of …", and its interactive "Select the fields to update" checklist no longer offers Description.

  • launch:env:get no longer prints a DESCRIPTION row.

  • ENVIRONMENT_DESCRIPTION_MAX_LENGTH and description are removed from the environment types.

  • The README entries for env:create and env:update no longer list the flag. They're edited by hand rather than regenerated with oclif readme, to avoid unrelated churn.

  • Every V2 command: clearer parse errors. oclif adds a second line, See more help with --help, to every parse error. That line is now replaced by a sentence on the same line, for example error: Nonexistent flag: --description. Run the command with --help to see its flags. Exit codes are unchanged, and oclif errors without that line (for example Flag --limit expects a value) print as before.

Not changed: project description (launch:projects:create / launch:projects:update --description) is a separate field and still works.

Tests

  • Existing env:create, env:update and env:get command tests, plus the updater, creator, prompt and presenter tests, are updated for the removed flag, request field, checklist entry and table row.
  • New assertions check that env:get prints no DESCRIPTION row and that the FileUpload checklist now offers 9 fields.
  • src/core/failure.test.ts feeds a real oclif Nonexistent flag parse error to reportFailure and checks the one-line wording and exit code 2.
  • npm test: 3,866 tests in 196 suites pass after merging the latest v2-dev. npm run lint is clean.

#claude_code#
🤖 Generated with Claude Code

SakshiKoli-CS and others added 2 commits November 19, 2026 11:03
…d env:get

The Launch UI never shows or edits an environment's description, and the
CLI's handling of it was broken: `env:update --description ""` was
treated as no flag (exit 2 alone, silently dropped when combined), and
the interactive Description prompt could neither set an empty value nor
clear an existing one. Match the UI instead of fixing a field nobody
else exposes.

- env:create and env:update no longer declare --description; passing it
  is oclif's unknown-flag error, and no description is sent to the API.
- env:update's "Pass at least one of ..." list and its interactive
  field checklist no longer offer it.
- env:get no longer prints a DESCRIPTION row.
- Remove ENVIRONMENT_DESCRIPTION_MAX_LENGTH and description from the
  environment types. Project description is untouched.

#claude_code#
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
…E entries

The generated command reference still listed the removed flag. Hand-edit
only the two env entries; project --description is unaffected.

#claude_code#
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@SakshiKoli-CS
SakshiKoli-CS requested review from a team as code owners November 19, 2026 05:35
@snyk-io

snyk-io Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 2 25 ✅ Passed
🟡 Medium Severity 0 1 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 0 0 30 / 120 days ✅ Passed
🟡 Medium 0 0 90 / 365 days ✅ Passed
🔵 Low 0 0 180 / 365 days ✅ Passed

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 2
  • Medium without fixes: 1
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

@github-actions

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 2 25 ✅ Passed
🟡 Medium Severity 0 1 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 0 0 30 / 120 days ✅ Passed
🟡 Medium 0 0 90 / 365 days ✅ Passed
🔵 Low 0 0 180 / 365 days ✅ Passed

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 2
  • Medium without fixes: 1
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

Harshi-Shah-CS
Harshi-Shah-CS previously approved these changes Nov 19, 2026
oclif appends "\nSee more help with --help" to every parse error, so an
unknown flag printed as two unpunctuated fragments:

  error: Nonexistent flag: --description
  See more help with --help

reportFailure now replaces that trailing hint with a sentence on the
same line:

  error: Nonexistent flag: --description. Run the command with --help to see its flags.

Exit codes are unchanged, and oclif errors without the hint are printed
as before.

#claude_code#
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 2 25 ✅ Passed
🟡 Medium Severity 0 1 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 0 0 30 / 120 days ✅ Passed
🟡 Medium 0 0 90 / 365 days ✅ Passed
🔵 Low 0 0 180 / 365 days ✅ Passed

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 2
  • Medium without fixes: 1
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants