Class: SleepingKingStudios::Docs::Commands::Installation::InstallWorkflow

Parent Namespace

SleepingKingStudios::Docs::Commands::Installation

Inherited Classes

Cuprum::Command > Object

Defined In

lib/sleeping_king_studios/docs/commands/installation/install_workflow.rb

Table Of Contents

• Overview
• Constructor
• Instance Methods
  • dry_run?
  • force?
  • initialize
  • verbose?

Overview

Installs the GitHub pages CI workflow.

Back To Top

Constructor

#initialize(**options) => Object

Overloads

#initialize(**options) => Object

Parameters

• options (Hash) — additional options for the command.

Options Hash (options)

• dry_run (Boolean) — if true, does not apply filesystem changes. Defaults to false.
• force (Boolean) — if true, replaces existing template files.
• verbose (Boolean) — if true, prints updates to STDOUT. Defaults to true.

Returns

• (InstallWorkflow) — a new instance of InstallWorkflow

Back To Top

Instance Methods

#dry_run? => Boolean

Returns

• (Boolean) — if true, does not apply filesystem changes.

#force? => Boolean

Returns

• (Boolean) — if true, overwrites existing template files.

#verbose? => Boolean

Returns

• (Boolean) — if true, prints updates to STDOUT.

Back To Top

---

Back to Documentation | Versions | 0.2 | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Commands | SleepingKingStudios::Docs::Commands::Installation