googleapis / googleapis/release-please

Support updating jsonc extraFiles

Open
#2,588 0 comments 0 reactions 1 assignee Claimed by @chingor13 View on GitHub
priority: p3 type: feature request
Dominant language
TypeScript
Stars
7.5k
Forks
588
Avg merge
12h 16m
Merged PRs (30d)
7

Description

Thanks for stopping by to let us know something could be better!

**Is your feature request related to a problem? Please describe.**
Many configs support using [JSONC](https://github.com/json-c/json-c) format which allows adding comments. But release-please seems to not be able to support updating these files out if the box.
When confguring such a file the CLI responds with the following error message:
```
release-please failed: unsupported extraFile type: undefined
```

**Describe the solution you'd like**
Detect the extension being .jsonc and support the same mechanism for updating the version using the `jsonpath` attribute.

**Describe alternatives you've considered**

- Provide an implementation that needs to be enabled using the `type` field?
- Use type `generic` and add an inline/block comment to tell release-please where to update the file, as described [here](https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files). (Other tools modifying the file might not keep the same formatting, so it might be brittle?)

**Additional context**
-

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.