googleapis / release-please-action

automated releases based on conventional commits
Apache License 2.0
1.64k stars 207 forks source link

Comments are purged from extra files of type .yaml #896

Closed DuncanCasteleyn closed 9 months ago

DuncanCasteleyn commented 9 months ago

TL;DR

extra files option purges all comments since V4 from yaml files

Expected behavior

Comments are retained

Observed behavior

image

Comments including # x-release-please are removed.

Action YAML

jobs:
  release-please:
    runs-on: [ self-hosted, Ubuntu-20.04 ]
    permissions:
      contents: write
      pull-requests: write

Log output

No response

Additional information

No response

chingor13 commented 9 months ago

This is in the upstream https://github.com/googleapis/release-please library that this action uses under the hood. The library uses js-yaml to parse/dump yaml contents.

Please reopen this issue there and also include your release-please-config.json because that's where your extra-files config is located

philippeboyd commented 7 months ago

@DuncanCasteleyn have you created the issue in https://github.com/googleapis/release-please ?

we're facing the same issue