Skip to content

openapi and yaml updaters wrap text and produce invalid YAML #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lain-mack opened this issue Mar 19, 2025 · 0 comments
Open

openapi and yaml updaters wrap text and produce invalid YAML #214

lain-mack opened this issue Mar 19, 2025 · 0 comments
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@lain-mack
Copy link

Describe the bug
openapi and yaml updaters inappropriately wrap text to produce invalid YAML.

Current behavior
When configuring an openapi-formatted file in bumpFiles with the type of either openapi or yaml, text fields (e.g. description, example, summary) that exceed some line length threshold are wrapped without using the multiline notation (i.e. |), thus producing invalid YAML.

Expected behavior
The openapi and yaml updaters should ideally not reformat any content but certainly not wrap any text to make the YAML invalid.

Environment

  • commit-and-tag-version version(s): 12.5.0
  • Node/npm version: Node 16/npm 8.19.2
  • OS: Sequoia 15.3.2

Possible Solution

Additional context

Image

@lain-mack lain-mack added the bug Something isn't working label Mar 19, 2025
@lain-mack lain-mack changed the title openapi and openapi and yaml updater wrap text and produce invalid YAML Mar 19, 2025
@lain-mack lain-mack changed the title openapi and yaml updater wrap text and produce invalid YAML openapi and yaml updaters wrap text and produce invalid YAML Mar 19, 2025
@TimothyJones TimothyJones added the help wanted Extra attention is needed label Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants