Skip to content

[RUN-5017] Document PowerShell file references - #2026

Open
luismalamoc wants to merge 2 commits into
4.0.xfrom
docs/RUN-5017-powershell-file-ref
Open

luismalamoc wants to merge 2 commits into
4.0.xfrom
docs/RUN-5017-powershell-file-ref

Conversation

@luismalamoc

Copy link
Copy Markdown
Contributor

Summary

Documents the behavior restored by rundeck/rundeck#10743:

  • WinRM PowerShell jobs receive an unresolved ${file.OptionName} argument literally when an optional File option is empty.
  • Windows cmd keeps double-quote handling for values containing spaces.
  • Scripts supporting multiple Rundeck versions should treat both the literal reference and an empty string as no file.

Validation

  • npm run docs:build

Co-authored-by: Cursor <cursoragent@cursor.com>
@luismalamoc
luismalamoc requested review from a team and a balanced review from Copilot October 29, 2026 13:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The release notes bypass the generation pipeline, risking loss on regeneration and omission from feeds, and claim SaaS availability for an unmerged fix not included in the configured deployment cut.

2 open issues
What changed in this PR

Documents the PowerShell file-option behavior addressed by rundeck/rundeck#10743 and explains how scripts can support multiple Rundeck versions.

Changes:

  • Describes literal unresolved file references when optional uploads are absent.
  • Clarifies PowerShell, Unix, and Windows cmd argument quoting.
  • Adds a SaaS update entry describing the fix and compatibility guidance.
File Description
docs/​manual/​jobs/​job-options.md Explains empty file-option handling and shell-specific quoting.
docs/​history/​updates/​index.md Adds a PowerShell regression-fix announcement and compatibility advice.

Review effort: Balanced

Comment thread docs/history/updates/index.md Resolved
Comment thread docs/history/updates/index.md Resolved
@luismalamoc luismalamoc added this to the 6.4.0 milestone Oct 29, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
@luismalamoc
luismalamoc requested a balanced review from Copilot October 29, 2026 14:17
@luismalamoc
luismalamoc marked this pull request as draft October 29, 2026 14:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues remain for the job-option documentation update.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

@luismalamoc
luismalamoc marked this pull request as ready for review October 29, 2026 15:13
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.

2 participants