docs(add-setup-md): add SETUP.md for Agentic Inner Loop KPI#1682
Open
giuliastf wants to merge 1 commit into
Open
docs(add-setup-md): add SETUP.md for Agentic Inner Loop KPI#1682giuliastf wants to merge 1 commit into
giuliastf wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a root-level setup guide intended to standardize local environment setup and provide a small “sample change” workflow for the Agentic Inner Loop KPI.
Changes:
- Introduces a new
SETUP.MDdocument covering prerequisites, env vars, setup/verify/build/test commands, and a sample code-change exercise.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,110 @@ | |||
| # SETUP.md | |||
Comment on lines
+10
to
+11
| - [x] Linux | ||
| - [ ] Windows |
Comment on lines
+24
to
+25
| | `UIPATH_URL` | UiPath platform base URL — required only for E2E tests, which are excluded from the default test run | Set to your tenant URL (e.g. `https://cloud.uipath.com/myorg/mytenant`) | | ||
| | `UIPATH_ACCESS_TOKEN` | Bearer token — required only for E2E tests | Generate from UiPath Cloud Platform | |
| def _make_span(span_id: int) -> MagicMock: | ||
| span = MagicMock() | ||
| span.get_span_context.return_value.span_id = span_id | ||
| del span.parent # ensure hasattr(span, "parent") is False |
0122942 to
0e63d3f
Compare
| @@ -0,0 +1,109 @@ | |||
| # SETUP.md | |||
Comment on lines
+10
to
+14
| This checklist controls the Agentic Inner Loop KPI pipeline targets (clean Linux VM). The repo's own GitHub Actions CI additionally tests on `windows-latest`, but that is not measured by this KPI. | ||
|
|
||
| - [x] Linux | ||
| - [ ] Windows | ||
| - [ ] macOS |
Comment on lines
+22
to
+25
| ### Project-specific | ||
|
|
||
| None. The unit-test suites under the `Test` section below run fully offline and require no external authentication. The repo's optional E2E tests (`pytest -m e2e`) are excluded from this KPI; their credentials (`UIPATH_URL`, `UIPATH_CLIENT_ID`, `UIPATH_CLIENT_SECRET`, `UIPATH_FOLDER_KEY`) are wired only in the dedicated GitHub Actions `e2e-uipath-platform` job and are out of scope here. | ||
|
|
Comment on lines
+60
to
+62
| uv --directory packages/uipath-core run pytest -m "not e2e" | ||
| uv --directory packages/uipath-platform run pytest -m "not e2e" | ||
| uv --directory packages/uipath run pytest -m "not e2e" |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



No description provided.