Skip to content
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

Disable CHANGELOG.json by default #979

Open
ecraig12345 opened this issue Sep 5, 2024 · 0 comments
Open

Disable CHANGELOG.json by default #979

ecraig12345 opened this issue Sep 5, 2024 · 0 comments

Comments

@ecraig12345
Copy link
Member

ecraig12345 commented Sep 5, 2024

Nothing in beachball reads the CHANGELOG.json file, and it's not that useful to users, while potentially using a lot of space in git history as noted in #978. (It's the only place where change entries with type none are recorded, but this probably has limited benefit; we could also add an option to include those in the markdown under "other changes" if desired.)

In the current version, we can add an option writeChangelogJson which defaults to true. In a major release, we can change the default of this option to false.

We have an option generateChangelog which currently defaults to true. #980 added 'md' and 'json' as possible values for this option, to allow writing only markdown (or only json if someone wants that for some reason).

In a major release, we can consider changing the default for generateChangelog to 'md'.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant