elastic / elastic/docs-builder

[Feature Request]: Automate / validate changelog area mappings

Open
#3,302 2 comments 0 reactions 0 assignees View on GitHub
ai-triaged ai:eng-question ai:writer-question enhancement needs triage stale
Dominant language
C#
Stars
24
Forks
44
Avg merge
1d 7h
Merged PRs (30d)
146

Description

### Prerequisites

- [x] I have searched existing issues to ensure this feature hasn't already been requested
- [x] I have tested using the latest version of docs-builder

### What problem are you trying to solve?

Per https://github.com/elastic/elasticsearch/pull/140141/changes#r3221759284, for teams that have PR/issue labels that change fairly frequently there's a manual step required to ensure the changelog configuration file's `pivot` settings are up-to-date. Otherwise, the changelog fields can't be derived and must be added by contributors manually.

### Proposed Solution

Per https://github.com/elastic/elasticsearch/pull/140141/changes#r3221759284, do teams need some kind of process that will automatically update the changelog configuration file's `pivot.areas`? Sounds like Elasticsearch might already have something like this in their old changelog system.

Alternatively, if a team decides that lack of an area label is a failure, making this a configurable validation check in the [changelog action](https://github.com/elastic/docs-actions/blob/main/changelog/README.md#how-it-works) and/or [evaluate-pr command](https://elastic.github.io/docs-builder/cli/changelog/evaluate-pr/) might suffice.

### Examples and Research

_No response_

### Alternative Solutions

_No response_

### Additional Context

_No response_

### How important is this feature to you?

Nice to have

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.