Add MakeReleaseNotes task (#5017)

* Fix changelog discrepancies

* Add new util methods

* Add changelog data type

* Add a MakeReleaseNotes task

* Add support for the release notes task

* Update the release workflow to use the new task

* Update the publishing plugin tests

* Add tests for the new task

* Add missing copyrights

* Fix typo

* Catch whitespace + remove todo comment

* Rename toPairOrNull and add comment about exception

* Fix type in separateAt

* Change capturedValue to firstCapturedValue

* Added support for github link transforms

* Add changelog format workflow

* Fixed some bugs

* Add some changes to the workflow for testing

* Fix format in yml

* Fix change-files version

* Change depth of fetch in workflow

* Trigger CI

* Map changed files

* trigger CI

* try to fix EOF

* See if removing EOF fixes it?

* Add python script to handle changelog comment

* Move to python script in workflow

* trigger ci

* Add setup python step

* trigger ci

* Fix arguments

* Remove equals from params

* trigger CI

* Fix exit code

* try to fix file location

* Remove CI triggers

* Add skipped entry for PR comment.

* Rename workflow

* Add EOF newline to workflow

* Add other missing EOF

* Update add-pr-comment

* Stop using message-path

* Test success message

* Add skip for workflow

* Utilize status

* Move status

* Use outcome

* typo

* trigger CI again

* Add output file

* try to use all files changed

* Ignore buildSrc files

* Fix typo

* Allow workflow to continue on error

* Add support for empty release notes

* Remove CI trigger

* Use unreleased instead of release for var name

* NO_RELEASE_CHANGE

* lock workflow to master

Author: daymxn

.github/workflows/build-release-artifacts.yml

@@ -26,11 +26,6 @@ jobs:
         run: |
           ./gradlew firebasePublish
 
-      - name: Generate release notes
-        run: |
-          python3 docs/make_release_notes.py
-          cd build/changelog && zip -r ../release_notes.zip android
-
       - name: Upload generated artifacts
         uses: actions/upload-artifact@v2
         with:

.github/workflows/release-note-changes.yml

@@ -0,0 +1,60 @@
+name: Release note changes
+
+on:
+  pull_request:
+    branches:
+      - 'master'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Create output file
+      run: touch changelog_comment.md
+
+    - name: Get changed changelog files
+      id: changed-files
+      uses: tj-actions/[email protected]
+      with:
+        files_ignore: |
+          buildSrc/**
+        files: |
+          **/CHANGELOG.md
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      if: ${{ steps.changed-files.outputs.any_changed == 'true' }}
+      with:
+        python-version: '3.10'
+          
+    - name: Set up fireci
+      id: install-fireci
+      if: ${{ steps.changed-files.outputs.any_changed == 'true' }}
+      run: pip3 install -e ci/fireci
+
+    - name: Generate comment
+      id: generate-comment
+      if: ${{ steps.install-fireci.outcome == 'success' }}
+      run: |
+        fireci changelog_comment -c "${{ steps.changed-files.outputs.all_changed_files }}" -o ./changelog_comment.md
+
+    - name: Add PR Comment
+      uses: mshick/[email protected]
+      continue-on-error: true
+      with:
+        status: ${{ steps.generate-comment.outcome }}
+        message-path: ./changelog_comment.md
+        message-skipped: |
+          ## Release note changes
+          No release note changes were detected. If you made changes that should be
+          present in the next release, ensure you've added an entry in the appropriate
+          `CHANGELOG.md` file(s).
+        message-failure: |
+          ## Release note changes
+          A `CHANGELOG.md` file seems to not match the expected format.
+          Please ensure your changelog files are following the format as
+          defined in [our documentation](#).

buildSrc/src/main/java/com/google/firebase/gradle/plugins/BaseFirebaseLibraryPlugin.kt

@@ -32,6 +32,16 @@ import org.gradle.kotlin.dsl.register
 import org.w3c.dom.Element
 
 abstract class BaseFirebaseLibraryPlugin : Plugin<Project> {
+  protected fun registerMakeReleaseNotesTask(project: Project) =
+    project.tasks.register<MakeReleaseNotesTask>("makeReleaseNotes") {
+      val changelog = project.file("CHANGELOG.md")
+      val releaseNotes by tempFile("release_notes.md")
+
+      onlyIf("Changelog file not found.") { changelog.exists() }
+
+      changelogFile.set(changelog)
+      releaseNotesFile.set(releaseNotes)
+    }
 
   protected fun kotlinModuleName(project: Project): String {
     val fullyQualifiedProjectPath = project.path.replace(":".toRegex(), "-")