@uipath/solution-tool 1.195.0 → 1.197.0-preview.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -55,3 +55,52 @@ auth context is active — `uip login`, `UIPATH_CLI_ENABLE_ENV_AUTH`, or
55
55
  terminals, CI pipelines, and Studio Desktop-spawned invocations. Service
56
56
  principals or robot accounts without a Personal Workspace produce a clear
57
57
  "not configured" error.
58
+
59
+ ### Excluding directories from the bundle
60
+
61
+ `uip solution pack` and `uip solution upload` skip developer-local
62
+ directories and credential files that don't belong in a published
63
+ solution. The defaults are always applied.
64
+
65
+ Directories (matched by exact name at any depth):
66
+
67
+ - `.venv` — Python virtualenvs (per-agent under `<solution>/<agent>/.venv`).
68
+ - `node_modules` — Node dependency caches.
69
+ - `__pycache__` — Python bytecode caches.
70
+ - `.git` — VCS metadata.
71
+
72
+ Files (matched by name pattern at any depth):
73
+
74
+ - `.env`, `.env.local`, `.env.production`, etc. (any file whose name is
75
+ `.env` or starts with `.env.`) — dotenv credential files. They commonly
76
+ hold API keys, database passwords, and OAuth client secrets, so they
77
+ are never shipped in the bundle. Lookalikes such as `.envrc`,
78
+ `.environment`, and `myenv.txt` are kept.
79
+
80
+ To skip additional directories, add a `.uipignore` file at the solution
81
+ root (next to the `.uipx` file). One directory name per line; `#` starts a
82
+ line or trailing comment; blank lines and whitespace-only lines are
83
+ ignored. Each entry matches by exact directory name at any depth — the
84
+ same semantics as the built-in defaults. Path separators (`/`, `\`) are
85
+ not supported yet.
86
+
87
+ Example `.uipignore`:
88
+
89
+ ```gitignore
90
+ # project-specific build artifacts
91
+ dist
92
+ coverage
93
+
94
+ # vendored deps we don't want shipped
95
+ vendor
96
+ ```
97
+
98
+ A `.uipignore` may also be placed at a **project root** (next to that
99
+ project's `project.uiproj`). Its entries are scoped to that project only and
100
+ are merged on top of the solution-root `.uipignore` and the built-in
101
+ defaults. Use this when an exclude should apply to one project but not its
102
+ siblings (a solution-root entry, by contrast, applies to every project). The
103
+ file format is identical.
104
+
105
+ The bundler logs which additional excludes are being applied at upload
106
+ time so the effective set is visible in CI logs.