Skip to content

Commit 9e73b9b

Browse files
authored
Update docs-impact-review.yml (mattermost#35589)
Automatic Merge
1 parent 0192d52 commit 9e73b9b

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

.github/workflows/docs-impact-review.yml

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,23 @@ jobs:
6969
### Code Paths and Documentation Relevance
7070
- `server/channels/api4/` — REST API handlers → API docs
7171
- `server/public/model/config.go` — Configuration settings struct → admin guide updates
72-
- `server/public/model/feature_flags.go` — Feature flags → may need documentation
72+
- `server/public/model/feature_flags.go` — Feature flags → these control gradual rollouts and are **distinct from configuration settings**
7373
- `server/public/model/websocket_message.go` — WebSocket events → API/integration docs
74+
- `server/public/model/audit_events.go` — Audit event definitions → new or changed audit event types should be documented for compliance officers
75+
- `server/public/model/support_packet.go` — Support packet contents → admin guide; changes to what data is collected or exported affect troubleshooting and support workflows
7476
- `server/channels/db/migrations/` — Database schema changes → admin upgrade guide
7577
- `server/channels/app/` — Business logic → end-user or admin docs if behavior changes
7678
- `server/cmd/` — CLI commands (mmctl) → admin CLI docs
7779
- `api/v4/source/` — OpenAPI YAML specs (auto-published to api.mattermost.com) → review for completeness
7880
- `webapp/channels/src/components/` — UI components → end-user guide if user-facing
7981
- `webapp/channels/src/i18n/` — Internationalization strings → new user-facing strings suggest new features
8082
- `webapp/platform/` — Platform-level webapp code
83+
- `server/Makefile` - changes to plugin version pins starting at line ~155 (major or minor version bumps) indicate plugin releases that may require documentation updates in the integrations or deployment guide
8184
</monorepo_paths>
8285
8386
<docs_directories>
8487
### Documentation Directories (`./docs/source/`)
85-
- `administration-guide/` — Server config, admin console, upgrade notes, CLI, server management
88+
- `administration-guide/` — Server config, admin console, upgrade notes, CLI, server management, support packet, audit events
8689
- `deployment-guide/` — Installation, deployment, scaling, high availability
8790
- `end-user-guide/` — User-facing features, messaging, channels, search, notifications
8891
- `integrations-guide/` — Webhooks, slash commands, plugins, bots, API usage
@@ -91,6 +94,7 @@ jobs:
9194
- `get-help/` — Troubleshooting guides
9295
- `product-overview/` — Product overview and feature descriptions
9396
- `use-case-guide/` — Use case specific guides
97+
9498
</docs_directories>
9599
96100
## Documentation Personas
@@ -102,7 +106,7 @@ jobs:
102106
Deploys, configures, and maintains Mattermost servers.
103107
- **Reads:** `administration-guide/`, `deployment-guide/`, `security-guide/`
104108
- **Cares about:** config settings, CLI commands (mmctl), database migrations, upgrade procedures, scaling, HA, environment variables, performance tuning
105-
- **Impact signals:** changes to `model/config.go`, `db/migrations/`, `server/cmd/`, `einterfaces/`
109+
- **Impact signals:** changes to `model/config.go`, `db/migrations/`, `server/cmd/`, `einterfaces/`, `model/audit_events.go`, `model/support_packet.go`
106110
107111
### End User
108112
Uses Mattermost daily for messaging, collaboration, and workflows.
@@ -114,7 +118,7 @@ jobs:
114118
Builds integrations, plugins, bots, and custom tools on top of Mattermost.
115119
- **Reads:** `integrations-guide/`, API reference (`api/v4/source/`)
116120
- **Cares about:** REST API endpoints, request/response schemas, webhook payloads, WebSocket events, plugin APIs, bot account behavior, OAuth/authentication flows
117-
- **Impact signals:** changes to `api4/` handlers, `api/v4/source/` specs, `model/websocket_message.go`, plugin interfaces
121+
- **Impact signals:** changes to `api4/` handlers, `api/v4/source/` specs, `model/websocket_message.go`, plugin interfaces, major/minor plugin version bumps in `server/Makefile`
118122
119123
### Security / Compliance Officer
120124
Evaluates and enforces security and regulatory requirements.
@@ -130,7 +134,11 @@ jobs:
130134
1. **Read the PR diff** using `gh pr diff ${{ github.event.issue.number }}` to understand what changed.
131135
2. **Categorize each changed file** by documentation relevance using one or more of these labels:
132136
- API changes (new endpoints, changed parameters, changed responses)
133-
- Configuration changes (new or modified settings in `config.go` or `feature_flags.go`)
137+
- Configuration changes (new or modified settings in `config.go`)
138+
- Feature flag changes (new or modified flags in `feature_flags.go` — treat separately from configuration settings; feature flags are not the same as config settings)
139+
- Audit event changes (new or modified audit event types in `audit_events.go`)
140+
- Support packet changes (new or modified fields in `support_packet.go`)
141+
- Plugin version changes (major or minor version bumps in `server/Makefile` starting around line 155)
134142
- Database schema changes (new migrations)
135143
- WebSocket event changes
136144
- CLI command changes
@@ -145,6 +153,10 @@ jobs:
145153
146154
Only flag changes that meet at least one of the two criteria above. Internal refactors, test changes, and implementation details that do not alter documented behavior or create a persona-relevant gap should not be flagged.
147155
156+
**Important distinctions to apply during analysis:**
157+
- Feature flags (`feature_flags.go`) are **not** configuration settings. Do not conflate them. Config settings belong in the admin configuration reference.
158+
- Plugin version bumps in `server/Makefile`: only major or minor version changes (e.g. `1.2.x` → `1.3.0` or `2.0.0`) warrant documentation review; patch-only bumps (e.g. `1.2.3` → `1.2.4`) generally do not.
159+
148160
## Output Format
149161
150162
Produce your response in exactly this markdown structure:

0 commit comments

Comments
 (0)