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

Read package rename options via configuration file #190

Open
mcmire opened this issue Mar 1, 2024 · 0 comments
Open

Read package rename options via configuration file #190

mcmire opened this issue Mar 1, 2024 · 0 comments

Comments

@mcmire
Copy link
Contributor

mcmire commented Mar 1, 2024

When create-release-branch adds commits to a package's changelog, it regenerates the whole file. If the package was renamed at some point, however, the tag references at the end of the changelog will reflect the rename (that is, at some point, the tag name may change). The core repo (which has some of these types of packages, e.g. json-rpc-engine) communicates this rename to this tool (auto-changelog) by passing a couple of command-line options, --tag-prefix-before-package-rename and --version-before-package-rename. However, those options are local to core and this tool doesn't know about them when run elsewhere. So when this tool updates changelogs for those kinds of packages via create-release-branch, it resets the tag references, making them invalid from core's perspective.

Instead of receiving this information through command-line options, this tool should receive it through a configuration file. This way, whether it is run via core or create-release-branch, it always generates the right changelog.

We could read the configuration file via cosmiconfig or some other mechanism.

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