Update CLI docs to reflect TE3 PR 3254 bpa run resolution chain#327
Conversation
- Rename two remaining TE_BPA_PATH references to TE_BPA_RULES in te-cli-limitations.md (env var was renamed in CLI commit 138136976). - Note te bpa run alongside the deploy/save gate as a consumer of every bpa.rules entry in te-cli-config.md. - Clarify te bpa run --rules description (replaces user-rule layer, not "additional") and add a "Rule sources and resolution" subsection covering the priority chain --rules > TE_BPA_RULES > bpa.rules config and the layered model used by the Rules loaded: output line.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-327.westeurope.azurestaticapps.net |
There was a problem hiding this comment.
Pull request overview
Updates Tabular Editor CLI documentation to match TE3 PR 3254 behavior for BPA rule-source resolution (including the TE_BPA_RULES env var rename) and clarifies how te bpa run composes rules from multiple layers.
Changes:
- Renames stale
TE_BPA_PATHreferences toTE_BPA_RULESin CLI limitations. - Clarifies that
te bpa run(in addition to the deploy/save gate) loads every existingbpa.rulesentry. - Refines
te bpa run --rulessemantics and adds a “Rule sources and resolution” subsection documenting layer priority and attribution output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| content/features/te-cli/te-cli-limitations.md | Updates BPA env var name references to TE_BPA_RULES. |
| content/features/te-cli/te-cli-config.md | Clarifies bpa.rules consumers (adds te bpa run alongside the gate). |
| content/features/te-cli/te-cli-commands.md | Improves --rules description and documents rule-layer resolution and priority. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-327.westeurope.azurestaticapps.net |
1 similar comment
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-327.westeurope.azurestaticapps.net |
The xref anchor #bpa-gate-keys does not correspond to any heading in te-cli-config.md (the closest relevant section is ### Built-in BPA rules). Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-327.westeurope.azurestaticapps.net |
|
@MariaJoseFF looks good to me, feel free to merge when the release that contains this PR goes live |
- Change <file-or-url> (line 410) and <path-or-url> (line 441) to <rules>, matching what te bpa run --help prints. The placeholder is auto-derived from the option name in TabularEditor3.CLI/Commands/BpaCommand.cs and no HelpName override is set, so <rules> is the canonical label users see. - Preserve the path-or-URL clarification: line 410's description already reads "path(s) or URL(s) to BPA rule file(s) in JSON format"; line 441's priority-list entry now reads "flag, accepts a file path or URL (highest)" so the clarification is retained without duplicating it in the placeholder.
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-327.westeurope.azurestaticapps.net |
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://delightful-mud-081affe03-327.westeurope.azurestaticapps.net |
|
Merging this PR since |
Summary
Corrects three stale references in the freshly-released CLI docs (PR #313) to match the behaviour shipped in TE3 PR 3254 (
fix(cli): te bpa run honours bpa.rules config and TE_BPA_PATH env var) and the follow-up env-var rename:te-cli-limitations.md-- rename two remainingTE_BPA_PATHreferences toTE_BPA_RULES. The env var was renamed in CLI commit138136976; the rest of the docs already use the new name.te-cli-config.md-- notete bpa runalongside the deploy/save gate as a consumer of everybpa.rulesentry. Previously the doc implied only the gate loaded every entry.te-cli-commands.md-- clarify thete bpa run --rulesdescription (it replaces the user-rule layer; it is not "additional") and add a new Rule sources and resolution subsection that walks through the three rule layers, the priority chain--rules>TE_BPA_RULES>bpa.rulesconfig, and theRules loaded:attribution line.End-to-end behaviour was verified live against
te.exebuilt fromorigin/mainof the TE3 repo (HEAD = 29ed35188) using the bundledmodel-with-bpa.bimfixture. All five user-story scenarios (no source /bpa.rulesconfig /TE_BPA_RULESenv var /--rulesflag /--no-defaults) attribute correctly.Test plan
te-cli-commands.mdand confirm the new Rule sources and resolution anchor links resolve.te-cli-config.mdand confirm thebpa.rulesrow reads correctly.te-cli-limitations.mdand confirm noTE_BPA_PATHstrings remain in the BPA section.