Create PR for NOTICES (#9708)

* Create a PR for Notices Generation.

Author: granluo

.github/actions/notices_generation/action.yml

@@ -12,11 +12,14 @@ inputs:
     description: 'The minimum version of iOS'
     required: true
     default: '10.0'
-  search_local_pod_version:
+  search-local-pod-version:
     description: 'Add pod version from local spec repo'
     required: true
     default: false
     type: boolean
+  notices-path:
+    description: 'Path of Notices file containing all licences.'
+    required: true
 outputs:
   notices_contents:
     description: 'contents of notices'
@@ -26,18 +29,18 @@ runs:
   - uses: ruby/setup-ruby@v1
     with:
       ruby-version: "2.7"
-  - name: First step
+  - name: Generate a NOTICES file
     run: |
       cd "${{ github.action_path }}"
       bundle install
-      if ${{ inputs.search_local_pod_version == 'true' }} ; then
-        ruby app.rb --pods ${{ inputs.pods }} --sources ${{ inputs.sources }} --min_ios_version ${{ inputs.min-ios-version }} --search_local_pod_version
+      if ${{ inputs.search-local-pod-version == 'true' }} ; then
+        ruby app.rb --pods ${{ inputs.pods }} --sources ${{ inputs.sources }} --min_ios_version ${{ inputs.min-ios-version }} --search_local_pod_version --notices_path ${{ inputs.notices-path }}
       else
-        ruby app.rb --pods ${{ inputs.pods }} --sources ${{ inputs.sources }} --min_ios_version ${{ inputs.min-ios-version }}
+        ruby app.rb --pods ${{ inputs.pods }} --sources ${{ inputs.sources }} --min_ios_version ${{ inputs.min-ios-version }} --notices_path ${{ inputs.notices-path }}
       fi
     shell: bash
   - name: Upload artifacts
     uses: actions/upload-artifact@v3
     with:
       name: notices
-      path: .github/actions/notices_generation/NOTICES
+      path: ${{ inputs.notices-path }}

.github/actions/notices_generation/app.rb

@@ -16,7 +16,6 @@
 
 require 'cocoapods'
 require 'digest'
-require 'octokit'
 require 'optparse'
 require 'plist'
 require 'tmpdir'
@@ -27,7 +26,7 @@
 # Default sources of min iOS version
 SOURCES=["https://cdn.cocoapods.org/"]
 MIN_IOS_VERSION="12.0"
-NOTICES_OUTPUT_PATH="./NOTICES"
+NOTICES_OUTPUT_PATH="./CoreOnly/NOTICES"
 SEARCH_LOCAL_POD_VERSION=false
 
 @options = {
@@ -42,8 +41,8 @@
     opts.on('-p', '--pods PODS', 'Pods seperated by space or comma.') { |v| @options[:pods] = v.split(/[ ,]/) }
     opts.on('-s', '--sources SOURCES', 'Sources of Pods') { |v| @options[:sources] = v.split(/[ ,]/) }
     opts.on('-m', '--min_ios_version MIN_IOS_VERSION', 'Minimum iOS version') { |v| @options[:min_ios_version] = v }
-    opts.on('-n', '--output_path OUTPUT_PATH', 'The output path of NOTICES') { |v| @options[:output_path] = v }
-    opts.on('-v', '--search-local-pod-version', 'Attach the latest pod version to a pod in Podfile') { |v| @options[:search_local_pod_version] = true }
+    opts.on('-n', '--notices_path OUTPUT_PATH', 'The output path of NOTICES') { |v| @options[:output_path] = v }
+    opts.on('-v', '--search_local_pod_version', 'Attach the latest pod version to a pod in Podfile') { |v| @options[:search_local_pod_version] = true }
   end.parse!
 
   raise OptionParser::MissingArgument if @options[:pods].nil?
@@ -121,18 +120,27 @@ def generate_notices_content(sources: SOURCES, pods: PODS, min_ios_version: MIN_
       create_podfile(path: temp_dir, sources: sources, target: DEFAULT_TESTAPP_TARGET,pods: pods, min_ios_version: min_ios_version, search_local_pod_version: SEARCH_LOCAL_POD_VERSION)
       pod_install_result = `pod install --allow-root`
       puts pod_install_result
-      licences = Plist.parse_xml("Pods/Target Support Files/Pods-testApp/Pods-testApp-acknowledgements.plist")
+      licenses = Plist.parse_xml("Pods/Target Support Files/Pods-testApp/Pods-testApp-acknowledgements.plist")
 
-      existing_licences={}
-      for licence in licences["PreferenceSpecifiers"] do
-        if existing_licences.include?(licence["FooterText"])
-          existing_licences.store(licence["FooterText"], existing_licences.fetch(licence["FooterText"])+"\n"+licence["Title"])
+      existing_licenses={}
+      for license in licenses["PreferenceSpecifiers"] do
+        if existing_licenses.include?(license["FooterText"])
+          existing_licenses.store(license["FooterText"], existing_licenses.fetch(license["FooterText"])+"\n"+license["Title"])
           next
         end
-        existing_licences.store(licence["FooterText"], licence["Title"])
+        existing_licenses.store(license["FooterText"], license["Title"])
       end
-      existing_licences.each{ |licence, title|
-        content += "#{title}\n#{licence}\n"
+      existing_licenses.each{ |license, title|
+        # The NOTICES format is like:
+        # ```
+        # ${title}
+        # ${license}
+        #
+        # ${title}
+        # ${license}
+        # ...
+        # ```
+        content += "#{title}\n#{license}\n\n"
       }
     end
   end

.github/workflows/notice_generation.yml

@@ -3,22 +3,26 @@ name: generate_notices
 on:
   pull_request:
     paths:
-    - '.github/workflows/testing_actions.yml'
+    - '.github/workflows/notice_generation.yml'
     - '.github/actions/notices_generation**'
 jobs:
   generate_a_notice:
     # Don't run on private repo.
     if: github.repository == 'Firebase/firebase-ios-sdk' && github.event_name != 'schedule'
     runs-on: macos-11
     name: Generate NOTICES
+    env:
+      # The path of NOTICES based on the root dir of repo."
+      NOTICES_PATH: "CoreOnly/NOTICES"
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Get all pod names
       run: |
         cd "${GITHUB_WORKSPACE}/ReleaseTooling/"
         swift run manifest --pod-name-output-file-path ./output.txt
         PODS=`cat ./output.txt`
         echo "PODS=${PODS}" >> $GITHUB_ENV
+        echo "NOTICES_PATH=${GITHUB_WORKSPACE}/${NOTICES_PATH}" >> $GITHUB_ENV
     - name: Create a local specs repo
       run: |
         cd "${GITHUB_WORKSPACE}/ReleaseTooling/"
@@ -30,4 +34,10 @@ jobs:
         pods: ${{ env.PODS }}
         sources: "https://github.com/firebase/SpecsTesting,https://github.com/firebase/SpecsStaging,https://cdn.cocoapods.org"
         min-ios-version: "13.0"
-        search_local_pod_version: true
+        search-local-pod-version: true
+        notices-path:  ${{ env.NOTICES_PATH }}
+    - name: Create a pull request
+      run: |
+        gem install octokit
+        ruby scripts/create_pull_request.rb --repo-root ${GITHUB_WORKSPACE} --repo-token ${{ secrets.GITHUB_TOKEN }} --notices-path  ${{ env.NOTICES_PATH }}
+      shell: bash

scripts/create_pull_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'octokit'
+require 'optparse'
+
+@options = {
+  repo_root: "./"
+}
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: create_pull_request.rb [options]"
+    opts.on('-r', '--repo-root REPO_ROOT', 'Root path of the repo dir.') { |v| @options[:repo_root] = v }
+    opts.on('-t', '--repo-token REPO_TOKEN', 'Token with write access') { |v| @options[:repo_token] = v }
+    opts.on('-n', '--notices-path NOTICES_PATH', 'Path of NOTICES file') { |v| @options[:notices_path] = v }
+  end.parse!
+
+  raise OptionParser::MissingArgument if @options[:repo_token].nil? || @options[:notices_path].nil?
+rescue OptionParser::MissingArgument
+  puts "Notices path, `--notices-path`, should be specified. " if @options[:notices_path].nil?
+  puts "A token ,`--repo-token`, should be provided for creating a pull request." if @options[:repo_token].nil?
+  raise
+end
+
+REPO_ROOT=@options[:repo_root]
+ACCESS_TOKEN=@options[:repo_token]
+NOTICES_PATH=@options[:notices_path]
+
+def generate_pr_for_notices_changes(repo_root:, notices_path:)
+  system("cd #{repo_root}")
+  system("git checkout -b notices_diff_detected\n git add CoreOnly/NOTICES\n git commit -m \"NOTICES diff detected.\"\n git push -u origin notices_diff_detected")
+  client = Octokit::Client.new(access_token: ACCESS_TOKEN)
+  client.create_pull_request("firebase/firebase-ios-sdk", "master", "notices_diff_detected", "Pull Request title", "Pull Request body")
+end
+
+
+def main()
+  generate_pr_for_notices_changes(repo_root: REPO_ROOT, notices_path: NOTICES_PATH)
+end
+
+main()
+