Class: Command::UpdateGithubActions

Inherits:
Base
  • Object
show all
Includes:
StagingBranchValidation
Defined in:
lib/command/update_github_actions.rb

Constant Summary collapse

NAME = 
"update-github-actions"
OPTIONS = 
[staging_branch_option].freeze
DESCRIPTION = 
"Regenerates generated GitHub Actions wrappers for the installed cpflow version"
LONG_DESCRIPTION = 
<<~DESC.freeze
  Regenerates the generated cpflow GitHub Actions wrappers and helper files
  from the currently installed cpflow gem. Use this after updating the
  cpflow gem so checked-in workflow wrappers move to the matching upstream
  release tag, for example `v#{Cpflow::VERSION}`.

  If the existing generated staging workflow uses a custom single staging
  branch, the command preserves it. Pass `--staging-branch BRANCH` to set or
  replace the generated staging branch explicitly.
DESC
EXAMPLES = 
<<~EX
  ```sh
  # After updating the cpflow gem, refresh generated GitHub Actions wrappers
  cpflow update-github-actions

  # When running cpflow through Bundler
  bundle exec cpflow update-github-actions

  # Preserve or set a custom staging branch
  cpflow update-github-actions --staging-branch develop
  ```
EX
WITH_INFO_HEADER = 
false
VALIDATIONS = 
[].freeze
REQUIRES_STARTUP_CHECKS = 
false
DEFAULT_STAGING_BRANCHES = 
%w[main master].freeze
STAGING_WORKFLOW_PATH = 
Pathname.new(".github/workflows/cpflow-deploy-staging.yml")

Constants inherited from Base

Base::ACCEPTS_EXTRA_OPTIONS, Base::ALL_VALIDATIONS, Base::DEFAULT_ARGS, Base::HIDE, Base::REQUIRES_ARGS, Base::SUBCOMMAND_NAME, Base::USAGE, Base::VALIDATIONS_WITHOUT_ADDITIONAL_OPTIONS, Base::VALIDATIONS_WITH_ADDITIONAL_OPTIONS

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

add_app_identity_option, all_commands, all_options, all_options_by_key_name, app_option, #args_join, commit_option, common_options, #cp, cpu_option, detached_option, dir_option, docker_context_option, domain_option, #ensure_docker_running!, entrypoint_option, force_option, image_option, #initialize, interactive_option, location_option, log_method_option, logs_limit_option, logs_since_option, memory_option, org_option, #progress, replica_option, #run_command_in_latest_image, #run_cpflow_command, run_release_phase_option, skip_confirm_option, skip_post_creation_hook_option, skip_pre_deletion_hook_option, skip_secret_access_binding_option, skip_secrets_setup_option, staging_branch_option, #step, #step_finish, terminal_size_option, trace_option, upstream_token_option, use_digest_image_ref_option, use_local_token_option, validations_option, verbose_option, version_option, wait_option, #with_retry, workload_option

Methods included from Helpers

normalize_command_name, normalize_option_name, random_four_digits, strip_str_and_validate

Constructor Details

This class inherits a constructor from Command::Base

Instance Method Details

#call ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/command/update_github_actions.rb', line 43

def call
  GenerateGithubActions.ensure_template_root!
  abort_if_no_generated_files!

  branch = staging_branch || inferred_staging_branch
  GithubActionsGenerator.start([branch].compact)

  print_post_update_message
end