fastlane-plugin-wpmreleasetoolkit 1.0.0

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setbranchprotection_action.rb

@@ -0,0 +1,56 @@
+require 'fastlane/action'
+require_relative '../../helper/github_helper'
+
+module Fastlane
+  module Actions
+    class SetbranchprotectionAction < Action
+      def self.run(params)
+        repository = params[:repository]
+        branch_name = params[:branch]
+        branch_prot = {}
+
+        branch_url = "https://api.github.com/repos/#{repository}/branches/" + branch_name
+        branch_prot[:restrictions] = { url: branch_url + '/protection/restrictions', users_url: branch_url + '/protection/restrictions/users', teams_url: branch_url + '/protection/restrictions/teams', users: [], teams: [] }
+        branch_prot[:enforce_admins] = nil
+        branch_prot[:required_pull_request_reviews] = { url: branch_url + '/protection/required_pull_request_reviews', dismiss_stale_reviews: false, require_code_owner_reviews: false }
+        Fastlane::Helper::GithubHelper.github_client().protect_branch(repository, branch_name, branch_prot)
+      end
+
+      def self.description
+        "Sets the 'release branch' protection state for the specified branch"
+      end
+
+      def self.authors
+        ['Lorenzo Mattei']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Sets the 'release branch' protection state for the specified branch"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository,
+                                       env_name: 'GHHELPER_REPOSITORY',
+                                       description: 'The remote path of the GH repository on which we work',
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                       env_name: 'GHHELPER_BRANCH',
+                                       description: 'The branch to protect',
+                                       optional: false,
+                                       type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setfrozentag_action.rb

@@ -0,0 +1,81 @@
+require 'fastlane/action'
+require_relative '../../helper/github_helper'
+
+module Fastlane
+  module Actions
+    class SetfrozentagAction < Action
+      def self.run(params)
+        repository = params[:repository]
+        milestone_title = params[:milestone]
+        freeze = params[:freeze]
+
+        milestone = Fastlane::Helper::GithubHelper.get_milestone(repository, milestone_title)
+        UI.user_error!("Milestone #{milestone_title} not found.") if milestone.nil?
+
+        mile_title = milestone[:title]
+        puts freeze
+        if freeze
+          # Check if the state needs changes
+          if is_frozen(milestone)
+            UI.message("Milestone #{mile_title} is already frozen. Nothing to do")
+            return # Already frozen: nothing to do
+          end
+
+          mile_title = mile_title + ' ❄️'
+        else
+          mile_title = milestone_title
+        end
+
+        UI.message("New milestone: #{mile_title}")
+        Fastlane::Helper::GithubHelper.github_client().update_milestone(repository, milestone[:number], title: mile_title)
+      end
+
+      def self.is_frozen(milestone)
+        return milestone[:title].include?('❄️') unless milestone.nil?
+
+        return false
+      end
+
+      def self.description
+        'Sets the frozen tag for the specified milestone'
+      end
+
+      def self.authors
+        ['Lorenzo Mattei']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        'Sets the frozen tag for the specified milestone'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository,
+                                       env_name: 'GHHELPER_REPOSITORY',
+                                       description: 'The remote path of the GH repository on which we work',
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :milestone,
+                                       env_name: 'GHHELPER_MILESTORE',
+                                       description: 'The GitHub milestone',
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :freeze,
+                                       description: 'The GitHub milestone',
+                                       optional: false,
+                                       default_value: true,
+                                       is_string: false),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_add_files_to_copy_action.rb

@@ -0,0 +1,96 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+require 'json'
+
+require_relative '../../helper/filesystem_helper'
+require_relative '../../helper/configure_helper'
+
+module Fastlane
+  module Actions
+    class ConfigureAddFilesToCopyAction < Action
+      def self.run(params = {})
+        continue = true
+
+        while continue
+
+          confirmation = 'Do you want to specify a file that should be copied from the secrets repository into your project?'
+
+          confirmation = 'Do you want to specify additional files that should be copied from the secrets repository into your project?' if Fastlane::Helper::ConfigureHelper.has_files
+
+          if UI.confirm(confirmation)
+            add_file
+          else
+            continue = false
+          end
+
+          Fastlane::Helper::ConfigureHelper.files_to_copy.each do |file_reference|
+            file_reference.update
+          end
+        end
+      end
+
+      ### Walks the user through adding a file to the project's `/.configure `file.
+      ###
+      def self.add_file
+        invalid_file = true
+
+        while invalid_file
+          UI.header 'Please provide the location of the source file relative to the secrets repository'
+          UI.message 'Example: google-services.json'
+
+          source = UI.input('Source File Path:')
+          sourcePath = absolute_secret_store_path(source) # Transform the relative path into an absolute path.
+
+          # Don't allow the developer to accidentally specify an invalid file, otherwise validation will never succeed.
+          if File.file?(sourcePath)
+            invalid_file = false
+          else
+            UI.error "There is no file at #{sourcePath}."
+          end
+        end
+
+        UI.header 'Please provide the destination of the file relative to the project root'
+        UI.message 'Example: WordPress/google-services.json'
+
+        destination = UI.input('Destination File Path:') # Leave the destination as a relative path, as no validation is required.
+
+        encrypt = UI.confirm('Encrypt file?:')
+
+        Fastlane::Helper::ConfigureHelper.add_file(source: source, destination: destination, encrypt: encrypt)
+      end
+
+      def self.secret_store_dir
+        Fastlane::Helper::FilesystemHelper.secret_store_dir
+      end
+
+      def self.absolute_secret_store_path(relative_path)
+        Fastlane::Helper::FilesystemHelper.absolute_secret_store_path(relative_path)
+      end
+
+      def self.description
+        'Interactively add files to the `files_to_copy` list in .configure.'
+      end
+
+      def self.authors
+        ['Jeremy Massel']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        'Interactively add files to the `files_to_copy` list in .configure.'
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_apply_action.rb

@@ -0,0 +1,139 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+require 'diffy'
+
+require_relative '../../helper/filesystem_helper'
+require_relative '../../helper/configure_helper'
+
+module Fastlane
+  module Actions
+    class ConfigureApplyAction < Action
+      def self.run(params = {})
+        # Preflight
+        UI.user_error!('Decryption key could not be found') if Fastlane::Helper::ConfigureHelper.encryption_key.nil?
+
+        # Checkout the right commit hash etc. before applying the configuration
+        prepare_repository do
+          # Copy/decrypt the files
+          files_to_copy.each do |file_reference|
+            apply_file(file_reference, params[:force])
+          end
+        end
+        UI.success 'Applied configuration'
+      end
+
+      def self.prepare_repository
+        secrets_respository_exists = File.exist?(repository_path)
+
+        # If the secrets repo doesn't exist, just run the block
+        unless secrets_respository_exists
+          # Run the provided block, and return
+          yield
+          return
+        end
+
+        ### Make sure secrets repo is at the proper hash as specified in .configure.
+        repo_hash = Fastlane::Helper::ConfigureHelper.repo_commit_hash
+        file_hash = Fastlane::Helper::ConfigureHelper.configure_file_commit_hash
+
+        ### Get the ref to restore the repo to
+        original_repo_ref = Fastlane::Helper::ConfigureHelper.repo_branch_name
+        original_repo_ref = repo_hash if original_repo_ref.nil?
+
+        other_action.sh(command: "cd #{repository_path} && git fetch && git checkout #{file_hash}", log: false) unless repo_hash == file_hash
+
+        # Run the provided block
+        yield
+
+        ### Restore secrets repo to original branch.  If it was originally in a
+        ### detached HEAD state, we need to use the hash since there's no branch name.
+        other_action.sh(command: "cd #{repository_path} && git checkout #{original_repo_ref}", log: false)
+      end
+
+      ### Check with the user whether we should overwrite the file, if it exists
+      ###
+      def self.apply_file(file_reference, force)
+        # If the file doesn't exist or force is true, we don't need to confirm
+        if !File.file?(file_reference.destination) || force
+          file_reference.apply
+          return # Don't continue if we were able to copy the file without conflict
+        end
+
+        unless file_reference.needs_apply?
+          return # Nothing to do if the files are identical
+        end
+
+        puts Diffy::Diff.new(file_reference.destination_contents, file_reference.source_contents) if UI.confirm("#{file_reference.destination} has changes that need to be merged. Would you like to see a diff?")
+
+        if UI.confirm("Would you like to make a backup of #{file_reference.destination}?")
+          extension = File.extname(file_reference.destination)
+          base = File.basename(Pathname.new(file_reference.destination), extension)
+
+          date_string = Time.now.strftime('%m-%d-%Y--%H-%M-%S')
+
+          backup_path = base
+                        .concat('-') # Handy-dandy separator
+                        .concat(date_string) # date string to allow multiple backups
+                        .concat(extension) # and the original file extension
+                        .concat('.bak') # add the .bak file extension - easier to .gitignore
+
+          # Create the destination directory if it doesn't exist
+          FileUtils.mkdir_p(Pathname.new(file_reference.destination).dirname)
+          FileUtils.cp(file_reference.destination, backup_path)
+        end
+
+        if UI.confirm("Would you like to overwrite #{file_reference.destination}?")
+          file_reference.apply
+        else
+          UI.message "Skipping #{file_reference.destination}"
+        end
+      rescue StandardError => e
+        UI.user_error!(e)
+      end
+
+      def self.repository_path
+        Fastlane::Helper::FilesystemHelper.secret_store_dir
+      end
+
+      def self.files_to_copy
+        Fastlane::Helper::ConfigureHelper.files_to_copy
+      end
+
+      def self.absolute_project_path(relative_path)
+        Fastlane::Helper::FilesystemHelper.absolute_project_path(relative_path)
+      end
+
+      def self.absolute_secret_store_path(relative_path)
+        Fastlane::Helper::FilesystemHelper.absolute_secret_store_path(relative_path)
+      end
+
+      def self.description
+        'Copy files specified in `.config` from the secrets repository to the project. Specify force:true to avoid confirmation'
+      end
+
+      def self.authors
+        ['Jeremy Massel']
+      end
+
+      def self.details
+        'Copy files specified in `.config` from the secrets repository to the project. Specify force:true to avoid confirmation'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :force,
+                                       env_name: 'FORCE_OVERWRITE',
+                                       description: 'Overwrite copied files without confirmation',
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_download_action.rb

@@ -0,0 +1,57 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+
+module Fastlane
+  module Actions
+    class ConfigureDownloadAction < Action
+      def self.run(params = {})
+        UI.message 'Running Configure Download'
+
+        # If the `~/.mobile-secrets` repository doesn't exist
+        unless File.directory?(secrets_dir)
+          UI.user_error!("The local secrets store does not exist. Please clone it to #{secrets_dir} before continuing.")
+        else
+          update_repository # If the repo already exists, just update it
+        end
+      end
+
+      # Ensure the git repository at `~/.mobile-secrets` is up to date.
+      # If the secrets repo is in a detached HEAD state, skip the pull,
+      # since it will fail.
+      def self.update_repository
+        secrets_repo_branch = Fastlane::Helper::ConfigureHelper.repo_branch_name
+
+        sh("cd #{secrets_dir} && git pull") unless secrets_repo_branch.nil?
+      end
+
+      def self.secrets_dir
+        Fastlane::Helper::FilesystemHelper.secret_store_dir
+      end
+
+      def self.description
+        'Updates the mobile secrets.'
+      end
+
+      def self.authors
+        ['Jeremy Massel']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        'Pulls down the latest remote changes to the ~/.mobile-secrets repository.'
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_setup_action.rb

@@ -0,0 +1,86 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+require 'git'
+
+require_relative '../../helper/filesystem_helper'
+require_relative '../../helper/configure_helper'
+
+module Fastlane
+  module Actions
+    class ConfigureSetupAction < Action
+      def self.run(params = {})
+        # Check to see if the local secret storage is set up at ~/.mobile-secrets.
+        UI.user_error!('The local secrets store does not exist. Please clone it to ~/.mobile-secrets before continuing.') unless File.directory?(repository_path)
+
+        # Checks to see if .configure exists. If so, exit – there’s no need to continue as everything is set up.
+        if configuration_file_exists
+          UI.success 'Configure file exists – exiting.'
+          return
+        end
+
+        # The mobile secrets repo must be up to date in order to generate and save the encryption key
+        prompt_to_update_to_most_recent_version if Fastlane::Helper::ConfigureHelper.repo_is_behind_remote
+
+        # Generate an encryption key for the new project, if needed
+        Fastlane::Helper::ConfigureHelper.update_project_encryption_key if Fastlane::Helper::ConfigureHelper.project_encryption_key.nil?
+
+        # Write out the `.configure` file.
+        Fastlane::Helper::ConfigureHelper.update_configure_file_from_repository
+
+        # Walk the user through adding files to copy to the `.configure` file.
+        ConfigureAddFilesToCopyAction.run
+
+        # Copy the files we just walked the user through setting up.
+        ConfigureApplyAction.run
+
+        UI.success 'Created .configure file'
+      end
+
+      def self.prompt_to_update_to_most_recent_version
+        if UI.confirm("The current branch is #{Fastlane::Helper::ConfigureHelper.repo_commits_behind_remote} commit(s) behind. It must be updated to complete the setup. Would you like to continue?")
+          update_branch
+        else
+          UI.user_error!('Cannot complete setup when the repo is not up to date.')
+        end
+      end
+
+      ### Ensure that the local secrets respository is up to date
+      def self.update_branch
+        sh("cd '#{Fastlane::Helper::FilesystemHelper.secret_store_dir}' && git pull")
+      end
+
+      def self.configuration_file_exists
+        Fastlane::Helper::ConfigureHelper.configuration_path_exists
+      end
+
+      def self.repository_path
+        Fastlane::Helper::FilesystemHelper.secret_store_dir
+      end
+
+      def self.description
+        'Set up the .configure file'
+      end
+
+      def self.authors
+        ['Jeremy Massel']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        'Interactively walks the user through setting up the `.configure` file. Assumes the ~/.mobile-secrets directory exists'
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end