Implement centralized config for Release Note generation #6099
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Release note changesNo release note changes were detected. If you made changes that should be |
Size Report 1Affected ProductsNo changes between base commit (f23f6f1) and merge commit (6b47830).Test Logs |
Coverage Report 1Affected Products
Test Logs |
davidmotson
approved these changes
Jul 12, 2024
rlazo
reviewed
Jul 16, 2024
| @@ -19,7 +19,9 @@ plugins { | |||
| firebaseLibrary { | |||
| publishSources = true | |||
| publishJavadoc = false | |||
| publishReleaseNotes = false | |||
| releaseNotes { | |||
| enabled.set(false) | |||
There was a problem hiding this comment.
why are these set rather than = like publish* ?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per b/352342089,
This implements a new extension through
FirebaseLibrarycalledReleaseNotesConfigurationExtension. This can be configured through thereleaseNoteshelper method that takes anActionargument; similar to what we do withFirebaseTestLabExtensionandFirebaseStaticAnalysis.The goal of this move is to not only allow teams to modify their release notes metadata, but provide an obvious indicator of release note configuration that must be changed to properly generate release notes. This way, we avoid accidentally not generating release notes for libraries that should otherwise have them.
Furthermore, this opens the door for exposing more release note configurations to product teams (such as
annotationsNotToDisplay,suppressedFiles,includedHeadTagsPath,package-listmappings, etc.,).NO_RELEASE_CHANGE