Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Allow manual changes to persist across --overrideΒ #139

Open
@YellowKirby

Description

@YellowKirby

Hello,

We've been happily using GREN on an enterprise Github instance to generate release notes based on PR data. We have a use-case where we'd like to add additional, hand-crafted release notes on top of the GREN-generated data that could be persisted even when using --override. This would be really useful in adding migration guides for major/breaking releases. We often end up regenerating the GREN release notes in order to add clarifications to PR titles.

Would it be possible to have the GREN-generated data live in a special block that GREN could replace rather than overwriting the entire body?

e.g., for the following release body:

// Hand-crafted release notes here
# Migration Guide
...

<!-- GREN-BEGIN -->
// Generated GREN data goes here
<!-- GREN-END -->

When using --override, GREN would only replace/regenerate the contents between the GREN-BEGIN and GREN-END comment blocks so that any manual additions to the release notes are not overwritten. Since these blocks are just HTML comments, they wouldn't end up visible in the overall release page.

FWIW, here's the .grenrc that we're using. Unfortunately I can't share the specific repo data because enterprise πŸ˜•

module.exports = {
	dataSource: 'prs',
	prefix: '',
	onlyMilestones: false,
	groupBy: {
		'πŸ’₯ Breaking Changes πŸ’₯': ['Major (Breaking Change)'],
		'✨ Non-Breaking New Features ✨': ['Minor (New Feature)'],
		'πŸ› οΈ Bug Fixes + Misc πŸ› οΈ': ['Patch (Bug Fix)']
	},
	changelogFilename: 'CHANGELOG.md'
};

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions