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

Add "gren" configuration for easy changelog generation. #1226

Merged
merged 1 commit into from
May 27, 2021

Conversation

digisomni
Copy link
Member

You can read more about it here: https://github.com/github-tools/github-release-notes

I am going to add this to our other repositories as well so that I can generate changelogs for release notes from each pull request.

You can see an example of how the output ends up looking here: https://github.com/vircadia/vircadia-docs-sphinx/pull/154/files?short_path=880352b#diff-880352b5c67c6cde1551356bcfb4055537afbeef3be4cfa51cf4e1a11e983e2f

@digisomni digisomni added docs Improvements or additions to documentation enhancement New feature or request needs CR (code review) labels May 25, 2021
@digisomni digisomni added this to the 2021.2.0 Selene Release milestone May 25, 2021
@digisomni digisomni merged commit 9640a13 into master May 27, 2021
@digisomni digisomni deleted the feature/gren-changelog-gen branch May 28, 2021 00:18
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
// This configuration is for generating a changelog with gren for a GitHub repository.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a URL to information about gren?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Docs": ["docs"]
},
"changelogFilename": "CHANGELOG.md"
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add CR at end of file.

@digisomni digisomni changed the title Add "gren" configuration for easy changelog generation Add "gren" configuration for easy changelog generation. Sep 7, 2021
@digisomni digisomni added the housekeeping Code or documentation cleanup label Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request housekeeping Code or documentation cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants