Skip to content

Commit 84f6df2

Browse files
committed
ci: trigger docs rebuild on platform/core source changes
docs are generated from docstrings in uipath-platform and uipath-core via mkdocstrings, but the publish workflow only triggered on changes to packages/uipath/docs/. new or updated service methods in platform/core were not reflected on the docs site until an unrelated docs change happened to trigger a rebuild.
1 parent c209c76 commit 84f6df2

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

.github/workflows/publish-docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ on:
99
- "packages/uipath/docs/**"
1010
- "packages/uipath/mkdocs.yml"
1111
- "packages/uipath/pyproject.toml"
12+
- "packages/uipath-platform/src/**"
13+
- "packages/uipath-platform/pyproject.toml"
14+
- "packages/uipath-core/src/**"
15+
- "packages/uipath-core/pyproject.toml"
1216
repository_dispatch:
1317
types: [publish-docs]
1418

packages/uipath-platform/src/uipath/platform/entities/entities.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
"""Entities models for UiPath Platform API interactions."""
1+
"""Entities models for UiPath Platform API interactions.
2+
3+
Includes models for entities, records, fields, choice sets, and external connections.
4+
"""
25

36
from __future__ import annotations
47

@@ -223,7 +226,10 @@ class SourceJoinCriteria(BaseModel):
223226

224227

225228
class ChoiceSetValue(BaseModel):
226-
"""Model representing a single value within a choice set."""
229+
"""Model representing a single value within a choice set.
230+
231+
Each value has a numeric ``number_id`` and a human-readable ``display_name``.
232+
"""
227233

228234
model_config = ConfigDict(
229235
validate_by_name=True,

0 commit comments

Comments
 (0)