class

MStrap::Project

Inherits MStrap::DSL < MStrap::DSL::System < MStrap::DSL::Logging < Reference < Object

Class methods

for(project_def : Defs::ProjectDef)

Factory constructor for Project from a project definition

Source

Instance methods

clone

Clones the project from Git

Source
cname

Returns canonical name for the project. This must be unique among projects.

Source
git_upstream_uri

Returns a usable Git URI for the project's upstream, or nil if not specified

Source
git_uri

Returns a usable Git URI for the project

Source
hostname

Returns hostname for the project.

Source
name

Returns friendly display name for the project.

Source
path

Returns path to the project on the filesystem.

Source
port

Returns the port for the project, if configured.

Source
pull

Updates the project from Git, including auto-stashing any unstaged and uncommited changes.

Source
repo

Returns the configured GitHub path or URI for the project's repo.

Source
repo_upstream

Returns the configured GitHub path or URI for the project's upstream repo, if configured.

Source
run_scripts?

Returns whether to execute and scripts-to-rule-them-all scripts, if they exist.

Source
runtimes

Returns the language runtimes of the project, if specified.

Source
upstream

Returns the NGINX upstream for the project. Relevant only to web projects.

Source
web?

Returns whether the project is a web project.

Source
websocket?

Returns whether the project requires a websocket connection

Source