-
Notifications
You must be signed in to change notification settings - Fork 174
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
Conversation
The following links are available: build (ubuntu-18.04, full)
build (macOS-latest, full) build (windows-latest, full) build (ubuntu-18.04, android) |
// 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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" | ||
} |
There was a problem hiding this comment.
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.
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