MetaMask / MetaMask/auto-changelog

Allow empty releases

Open
#115 0 comments 0 reactions 0 assignees View on GitHub
enhancement team-wallet-framework wf-release-process
Dominant language
TypeScript
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

[Currently](https://github.com/MetaMask/auto-changelog/blob/1c931ec77867f2d70ff5197cc25ee7dba99d2425/src/update-changelog.ts#L177), if we can't find any commits to add to the changelog, and the `--rc` option was provided or if there are already unreleased changes present in the changelog, the changelog is left unaltered and `updateChangelog` returns undefined.

This should be changed slightly:

* If the `--rc` option was provided and a new option `--allow-empty-releases` is provided, then a new section should be added to the changelog which merely reads something like "There are no changes for this release." (This is designed for monorepos which use a fixed versioning scheme, where even if a package has no changes, we may still want to create a new release for that package.)
* Otherwise, undefined should be returned.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at src/update-changelog.ts around line 177, then trace how the --rc option is handled. Add support for --allow-empty-releases so an RC with no commits can add a no-changes section, while other cases still return undefined; verify both behaviors with the repository's existing checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.