mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-06 17:36:53 +01:00
86 lines
2.8 KiB
Markdown
86 lines
2.8 KiB
Markdown
---
|
|
rule: CURABIS-BCMCP-008
|
|
title: Git lifecycle must sync BC subtask dev status
|
|
severity: warning
|
|
domain: git, mcp, bc-integration
|
|
applies-to: [feature branches, bugfix branches, hotfix branches]
|
|
---
|
|
|
|
# Git lifecycle must sync BC subtask dev status
|
|
|
|
Every AL feature branch is linked to a BC subtask. The `gitHubDevStatus` and
|
|
`gitHubBranch` fields on the subtask must reflect the real state of the branch
|
|
at all times — automatically, without manual steps.
|
|
|
|
## Branch naming convention
|
|
|
|
Branches must follow this pattern so automation can parse the BC task reference:
|
|
|
|
```
|
|
<type>/<projectNo>-<taskNo>[-optional-description]
|
|
```
|
|
|
|
| Segment | Format | Example |
|
|
| --- | --- | --- |
|
|
| type | `feature`, `bugfix`, `hotfix` | `feature` |
|
|
| projectNo | `[A-Z]{2,4}\d{4}-\d{5}` | `DEV2023-00027` |
|
|
| taskNo | zero-padded or plain integer | `004` or `4` |
|
|
| description | optional, hyphen-separated | `bc-agent-semantic-tools` |
|
|
|
|
**Valid examples:**
|
|
```
|
|
feature/DEV2023-00027-004-bc-agent-semantic-tools
|
|
bugfix/DEV2023-00027-003-odata-string-key
|
|
hotfix/DEV2023-00012-001-invoicing-crash
|
|
feature/DEV2023-00027-4
|
|
```
|
|
|
|
**Invalid (no automation):**
|
|
```
|
|
my-feature
|
|
fix-thing
|
|
DEV2023-00027
|
|
```
|
|
|
|
## Status mapping
|
|
|
|
| Git event | gitHubDevStatus | gitHubBranch |
|
|
| --- | --- | --- |
|
|
| New branch created (`git checkout -b`) | `In Progress` | `<branch-name>` |
|
|
| Branch abandoned (switch to non-main without committing) | `Backlog` | `""` |
|
|
| Merged/committed to main | `Done` | `main` |
|
|
| Branch parked (manual) | `On Hold` | `<branch-name>` |
|
|
|
|
## Implementation
|
|
|
|
Automation is provided by two git hooks in `.githooks/` (activated via
|
|
`git config core.hooksPath .githooks`) that call
|
|
`Scripts/Invoke-BCGitSync.ps1`:
|
|
|
|
- `post-checkout` — detects branch creation and branch abandonment
|
|
- `post-commit` — detects commits/merges on main
|
|
|
|
`Invoke-BCGitSync.ps1` calls the BC OData API directly (same credentials as
|
|
`bc-agent.js`) and never blocks the git operation — all errors are swallowed
|
|
with a warning.
|
|
|
|
## Safety rules
|
|
|
|
CURABIS-BCMCP-008 The sync script NEVER writes BC subtask `status`
|
|
(Created/Accepted/In progress/Finished/Invoiced). It only writes
|
|
`gitHubDevStatus` and `gitHubBranch`. These are the only two fields
|
|
the agent is allowed to modify (see CURABIS-BCMCP-001).
|
|
|
|
CURABIS-BCMCP-009 The sync script exits 0 on all errors. It must never
|
|
block a git commit, checkout, or merge. BC sync is best-effort.
|
|
|
|
CURABIS-BCMCP-010 Only tasks in `activeTasks` (status = Accepted or In progress)
|
|
are updated. A branch against a `Created` task is silently ignored until the
|
|
task is approved in BC.
|
|
|
|
## BCApps reference
|
|
|
|
Branch naming conventions and git workflow integration follow the patterns used
|
|
in [microsoft/BCApps](https://github.com/microsoft/BCApps) — see
|
|
`.github/CONTRIBUTING.md` for Microsoft's own conventions on feature branches
|
|
and PR titles that reference work items.
|