Update NOTICES workflow. (#9754)

* Run workflow in nightly.

Author: granluo

.github/workflows/notice_generation.yml

@@ -5,10 +5,13 @@ on:
     paths:
     - '.github/workflows/notice_generation.yml'
     - '.github/actions/notices_generation**'
+  schedule:
+    # Run every day at 5am (PST) - cron uses UTC times
+    - cron:  '0 13 * * *'
 jobs:
   generate_a_notice:
     # Don't run on private repo.
-    if: github.repository == 'Firebase/firebase-ios-sdk' && github.event_name != 'schedule'
+    if: github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule'
     runs-on: macos-12
     name: Generate NOTICES
     env:
@@ -38,12 +41,13 @@ jobs:
         notices-path:  ${{ env.NOTICES_PATH }}
     - name: Create a pull request
       run: |
+        RUN_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
         gem install octokit
         ruby scripts/create_pull_request.rb \
         --repo-root ${GITHUB_WORKSPACE} \
         --repo-token ${{ secrets.GITHUB_TOKEN }} \
         --target-path  ${{ env.NOTICES_PATH }} \
         --pr-title "NOTICES Change" \
-        --pr-body "NOTICES Change is detected." \
+        --pr-body "NOTICES Change is detected in [this GitHub Actions Run](${RUN_URL})." \
         --commit-comment "NOTICES change."
       shell: bash

scripts/create_pull_request.rb

@@ -32,8 +32,8 @@
     opts.on('-n', '--target-path PATH', 'Path of targeted file or dir') { |v| @options[:target_path] = v }
     opts.on('--pr-title PR_TITLE', 'Title of a PR') { |v| @options[:pr_title] = v }
     opts.on('--pr-body PR_BODY', 'Body of a PR') { |v| @options[:pr_body] = v }
-    opts.on('--base-branch', 'A new branch will be generated if not specified or the branch does not exist.') { |v| @options[:base_branch] = v }
-    opts.on('--commit-comment', 'Commit comment') { |v| @options[:commit_comment] = v }
+    opts.on('--base-branch BASE_BRANCH', 'A new branch will be generated if not specified or the branch does not exist.') { |v| @options[:base_branch] = v }
+    opts.on('--commit-comment COMMIT_COMMENT', 'Commit comment') { |v| @options[:commit_comment] = v }
   end.parse!
 
   raise OptionParser::MissingArgument if @options[:repo_token].nil? || @options[:target_path].nil?
@@ -47,17 +47,16 @@
 ACCESS_TOKEN=@options[:repo_token]
 TARGET_PATH=@options[:target_path]
 PR_TITLE=@options[:pr_title]
-PR_BODY=@options[:pr_boday]
+PR_BODY=@options[:pr_body]
 BASE_BRANCH=@options[:base_branch]
 COMMIT_COMMENT=@options[:commit_comment]
 
 def generate_pr_for_target_changes(repo_root:, target_path:)
-  system("cd #{REPO_ROOT}\ngit checkout -b #{BASE_BRANCH}\n")
   if `git diff #{TARGET_PATH}`==""
     puts "The file, #{TARGET_PATH}, has no changes."
     return
   end
-  system("git add #{TARGET_PATH}\ngit commit -m \"#{COMMIT_COMMENT}\"\n git push -u origin #{BASE_BRANCH}")
+  system("cd #{REPO_ROOT}\ngit checkout -b #{BASE_BRANCH}\ngit add #{TARGET_PATH}\ngit commit -m \"#{COMMIT_COMMENT}\"\ngit push -u origin #{BASE_BRANCH}")
   client = Octokit::Client.new(access_token: ACCESS_TOKEN)
   client.create_pull_request("firebase/firebase-ios-sdk", "master", BASE_BRANCH, PR_TITLE, PR_BODY)
 end
@@ -68,4 +67,3 @@ def main()
 end
 
 main()
-