Automate copyright update

Author: testableapple

.github/workflows/update-copyright.yml

@@ -0,0 +1,33 @@
+name: Copyright
+
+on:
+  schedule:
+    # Runs "At 08:00 on day-of-month 1 in January"
+    - cron: '0 8 1 1 *'
+
+  workflow_dispatch:
+
+env:
+  HOMEBREW_NO_INSTALL_CLEANUP: 1 # Disable cleanup for homebrew, we don't need it on CI
+
+jobs:
+  copyright:
+    name: Copyright
+    runs-on: macos-13
+    steps:
+    - uses: actions/[email protected]
+    - uses: ./.github/actions/ruby-cache
+    - run: bundle exec fastlane copyright
+      timeout-minutes: 5
+      env:
+        GITHUB_TOKEN: ${{ secrets.CI_BOT_GITHUB_TOKEN }}
+    - uses: 8398a7/action-slack@v3
+      with:
+        status: ${{ job.status }}
+        text: "You shall not pass!"
+        job_name: "${{ github.workflow }}: ${{ github.job }}"
+        fields: message,commit,author,action,workflow,job,took
+      env:
+        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+        MATRIX_CONTEXT: ${{ toJson(matrix) }}
+      if: failure()

Gemfile.lock

@@ -200,7 +200,7 @@ GEM
       fastlane
       pry
     fastlane-plugin-sonarcloud_metric_kit (0.2.1)
-    fastlane-plugin-stream_actions (0.3.20)
+    fastlane-plugin-stream_actions (0.3.28)
       xctest_list (= 1.2.1)
     fastlane-plugin-versioning (0.5.2)
     ffi (1.16.3)
@@ -417,7 +417,7 @@ DEPENDENCIES
   fastlane-plugin-emerge
   fastlane-plugin-lizard
   fastlane-plugin-sonarcloud_metric_kit
-  fastlane-plugin-stream_actions (= 0.3.20)
+  fastlane-plugin-stream_actions (= 0.3.28)
   fastlane-plugin-versioning
   jazzy
   json

fastlane/Fastfile

@@ -16,6 +16,7 @@ source_packages_path = 'spm_cache'
 buildcache_xcargs = 'CC=clang CPLUSPLUS=clang++ LD=clang LDPLUSPLUS=clang++'
 is_localhost = !is_ci
 @force_check = false
+develop_branch = 'main'
 
 before_all do |lane|
   if is_ci
@@ -149,20 +150,12 @@ lane :test_ui do |options|
     png_files = git_status(ext: '.png').map { |_, png| png }.flatten
     next if png_files.empty?
 
-    title = "[CI] Snapshots"
-    base = current_branch
-    head = "#{base}-snapshots"
-    sh("git checkout -b #{head}")
     png_files.each { |png| sh("git add #{png}") || true }
-    sh("git commit -m '#{title}'")
-    push_to_git_remote(tags: false)
-    create_pull_request(
-      api_token: ENV.fetch('GITHUB_TOKEN', nil),
-      repo: github_repo,
-      title: title,
-      head: head,
-      base: base,
-      body: 'This PR was created automatically by CI.'
+
+    create_pr(
+      title: '[CI] Snapshots',
+      base_branch: current_branch,
+      head_branch: "#{current_branch}-snapshots"
     )
   end
 end
@@ -379,6 +372,33 @@ lane :sources_matrix do
   }
 end
 
+lane :copyright do
+  update_copyright(ignore: [derived_data_path, source_packages_path, 'vendor/'])
+  next unless is_ci
+
+  create_pr(
+    title: '[CI] Update Copyright',
+    head_branch: "ci/update-copyright-#{Time.now.to_i}"
+  )
+end
+
+private_lane :create_pr do |options|
+  options[:base_branch] ||= develop_branch
+  sh("git checkout -b #{options[:head_branch]}")
+  sh('git add -A')
+  sh("git commit -m '#{options[:title]}'")
+  push_to_git_remote(tags: false)
+
+  create_pull_request(
+    api_token: ENV.fetch('GITHUB_TOKEN', nil),
+    repo: github_repo,
+    title: options[:title],
+    head: options[:head_branch],
+    base: options[:base_branch],
+    body: 'This PR was created automatically by CI.'
+  )
+end
+
 private_lane :current_branch do
   ENV['BRANCH_NAME'] || git_branch
 end

fastlane/Pluginfile

@@ -5,5 +5,5 @@
 gem 'fastlane-plugin-versioning'
 gem 'fastlane-plugin-emerge'
 gem 'fastlane-plugin-sonarcloud_metric_kit'
-gem 'fastlane-plugin-stream_actions', '0.3.20'
+gem 'fastlane-plugin-stream_actions', '0.3.28'
 gem 'fastlane-plugin-create_xcframework'