Class: Command::UpdateGithubActions

Inherits:

Base

• Object
• Base
• Command::UpdateGithubActions

Includes:

StagingBranchValidation

Defined in:

lib/command/update_github_actions.rb

Constant Summary

NAME =

"update-github-actions"

OPTIONS =

[staging_branch_option].freeze

DESCRIPTION =

"Regenerates generated GitHub Actions wrappers for the installed cpflow version"

LONG_DESCRIPTION =

"Regenerates the generated cpflow GitHub Actions wrappers and helper files\nfrom the currently installed cpflow gem. Use this after updating the\ncpflow gem so checked-in workflow wrappers move to the matching upstream\nrelease tag, for example `v\#{Cpflow::VERSION}`.\n\nIf the existing generated staging workflow uses a custom single staging\nbranch, the command preserves it. Pass `--staging-branch BRANCH` to set or\nreplace the generated staging branch explicitly.\n".freeze

EXAMPLES =

"```sh\n# After updating the cpflow gem, refresh generated GitHub Actions wrappers\ncpflow update-github-actions\n\n# When running cpflow through Bundler\nbundle exec cpflow update-github-actions\n\n# Preserve or set a custom staging branch\ncpflow update-github-actions --staging-branch develop\n```\n"

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

• #call ⇒ Object

Methods inherited from Base

add_app_identity_option, all_commands, all_options, all_options_by_key_name, app_option, #args_join, #bind_shared_secret_policy_grant, #bind_shared_secret_policy_grants, commit_option, common_options, #cp, cpu_option, detached_option, dir_option, docker_context_option, domain_option, #ensure_docker_running!, #ensure_shared_secret_policy_targets_secret!, entrypoint_option, force_option, #identity_bound_to_policy_with_reveal?, #identity_policy_permissions, image_option, #initialize, interactive_option, location_option, log_method_option, logs_limit_option, logs_since_option, memory_option, org_option, #progress, replica_option, #resolve_shared_secret_policy_grant, #resolve_shared_secret_policy_grants, #run_command_in_latest_image, #run_cpflow_command, run_release_phase_option, #shared_secret_policy_missing_message, #shared_secret_policy_target_links, #shared_secret_policy_targets_secret?, 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_for_workloads_ready, 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

# 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