Rocketeer API
  • Namespace
  • Class

Namespaces

  • Rocketeer
    • Abstracts
      • Strategies
    • Binaries
      • PackageManagers
    • Console
      • Commands
        • Plugins
      • Compilation
    • Exceptions
    • Facades
    • Interfaces
      • Strategies
    • Plugins
    • Scm
    • Services
      • Connections
      • Display
      • History
      • Ignition
      • Storages
      • Tasks
    • Strategies
      • Check
      • Dependencies
      • Deploy
      • Migrate
      • Test
    • Tasks
      • Plugins
      • Subtasks
    • Traits
      • BashModules

Classes

  • Check
  • Cleanup
  • Closure
  • CurrentRelease
  • Dependencies
  • Deploy
  • Ignite
  • Migrate
  • Rollback
  • Setup
  • Teardown
  • Test
  • Update

Class Check

Check if the server is ready to receive the application.

Rocketeer\Bash uses Rocketeer\Traits\BashModules\Core, Rocketeer\Traits\BashModules\Binaries, Rocketeer\Traits\BashModules\Filesystem, Rocketeer\Traits\BashModules\Flow
Extended by Rocketeer\Abstracts\AbstractTask uses Rocketeer\Traits\StepsRunner
Extended by Rocketeer\Tasks\Check
Namespace: Rocketeer\Tasks
Author: Maxime Fabre ehtnam6@gmail.com
Located at Rocketeer/Tasks/Check.php

Methods summary

public boolean|null
# execute( )

Run the task.

Run the task.

Returns

boolean|null
public boolean
# checkScm( )

Check the presence of an SCM on the server.

Check the presence of an SCM on the server.

Returns

boolean

Methods inherited from Rocketeer\Abstracts\AbstractTask

displayReleases(), displayStatus(), fire(), fireEvent(), getDescription(), getName(), getQualifiedEvent(), getSlug(), halt(), setDescription(), setEvent(), setName(), wasHalted()

Methods inherited from Rocketeer\Bash

executeTask(), getHookedTasks(), getStrategy()

Methods used from Rocketeer\Traits\StepsRunner

runSteps(), steps()

Methods used from Rocketeer\Traits\BashModules\Core

checkStatus(), cleanOutput(), displayCommands(), getConnection(), getTimestamp(), onLocal(), processCommands(), processOutput(), run(), runInFolder(), runLast(), runRaw(), runSilently(), setLocal(), shellCommand(), status(), sudoCommand()

Methods used from Rocketeer\Traits\BashModules\Binaries

artisan(), binary(), composer(), getBinaryStoragePath(), php(), phpunit(), rawWhich(), versionCheck(), which(), whichFrom()

Methods used from Rocketeer\Traits\BashModules\Filesystem

checkStatement(), copy(), createFolder(), fileExists(), fromTo(), getFile(), isSymlink(), listContents(), move(), putFile(), removeFolder(), setPermissions(), symlink(), symlinkSwap(), upload()

Methods used from Rocketeer\Traits\BashModules\Flow

isSetup(), runForCurrentRelease(), share(), syncSharedFolders(), updateSymlink(), usesStages()

Properties summary

protected string $description

A description of what the task does.

A description of what the task does.

Type

string
# 'Check if the server is ready to receive the application'
public boolean $usesStages

Whether the task needs to be run on each stage or globally.

Whether the task needs to be run on each stage or globally.

Type

bool
# false

Properties inherited from Rocketeer\Abstracts\AbstractTask

$event, $halted, $name

Properties used from Rocketeer\Traits\BashModules\Core

$local

Properties used from Rocketeer\Traits\StepsRunner

$steps

Rocketeer API API documentation generated by ApiGen