envoyproxy / envoyproxy/envoy

Release/changelog line length can be too long when converted from rst snippets

Open
#46,148 4 comments 0 reactions 0 assignees View on GitHub
area/release bug no stalebot
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 22h
Merged PRs (30d)
430

Description

i think we dont enforce line lenght on rst, and now that changelog snippets are rst, the lines can be too long when they are converted to yaml

one option would be to, do line mangling when converting, but that is inherently risk with rst

probably the better option is to just add some ci to ensure changelog rst snippets are not too long

Contributor guide

Open the contributing guide

Research direction

Trace how changelog RST snippets are converted to YAML and inspect the existing CI checks for a suitable validation point. Done means CI identifies changelog snippets whose converted lines would be too long, without performing risky RST line mangling.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.