Skip to content

docs: add SETUP.MD#128

Merged
giuliastf merged 1 commit into
mainfrom
docs/add-setup-md
Jun 16, 2026
Merged

docs: add SETUP.MD#128
giuliastf merged 1 commit into
mainfrom
docs/add-setup-md

Conversation

@giuliastf

Copy link
Copy Markdown
Contributor

Adds a top-level SETUP.MD documenting how to provision a clean development environment for uipath-runtime, run the build, execute the tests, and validate a sample code change.

The file includes:

  • Prerequisites and supported platforms (Linux/Windows/macOS via uv)
  • Setup, Verify Setup, Build, and Test commands
  • A prescribed sample code change (UiPathRuntimeFactoryRegistry.count) with unit tests
  • An end-to-end "Test with a real UiPath Coded Agent" flow showing how to validate changes against a real cloud deployment

Same shape as the recently merged equivalent on uipath-mcp-python (UiPath/uipath-mcp-python#217).

Copilot AI review requested due to automatic review settings June 16, 2026 12:14
@giuliastf giuliastf requested a review from a team as a code owner June 16, 2026 12:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a top-level developer setup guide (SETUP.MD) for the uipath-runtime Python package, intended to help contributors provision a clean environment with uv, run tests, and validate a sample change end-to-end (including a downstream “real agent” validation flow).

Changes:

  • Introduces SETUP.MD with prerequisites, setup/verify steps, and test commands.
  • Documents a sample code change + unit-test workflow for UiPathRuntimeFactoryRegistry.
  • Describes an optional dev-build/Test PyPI and downstream agent validation process.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread SETUP.MD
Comment thread SETUP.MD
Comment thread SETUP.MD
Comment thread SETUP.MD
@giuliastf giuliastf force-pushed the docs/add-setup-md branch 4 times, most recently from fd21e8b to ef595d5 Compare June 16, 2026 15:36
@giuliastf giuliastf force-pushed the docs/add-setup-md branch from ef595d5 to a8a8970 Compare June 16, 2026 16:05
@sonarqubecloud

Copy link
Copy Markdown

@giuliastf giuliastf merged commit 283e869 into main Jun 16, 2026
22 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