googleapis / googleapis/release-please

When should one use 'hidden' in 'changelog-sections'?

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

Description

## TL;DR

Instead of a `hidden` section in `changelog-sections`, why doesn't one just remove the section? Is there any practical difference?

## Background

I'm trying to customize the definition of releasable units, and I realized that the types defined in `changelog-sections` are essentially releasable units. As a result, I'm checking what's inside `changelog-sections`, and I found `hidden`. I did some experiments and realized that if a section is `hidden`, then the corresponding type is not a releasable unit anymore, hence the question in `TL;DR` above. I read [the description of `hidden` in the JSON schema](https://github.com/googleapis/release-please/blob/408ddac5dd4e1bc2c9b992365fa864e80298cee5/schemas/config.json#L41-L43), but it does not seem to mention _when_ `hidden` can be useful.

Thank you for reading, and please let me know if I'm missing anything, thanks!

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.