The blueprint resource is a special type of resource which allows you to specify certain global parameters for Shipyard, and information which is output when someone runs the blueprint. Blueprint READMEs help the users of your blueprint get started, any information such as the URIs for created resources should be included as should any passwords or other information needed to interact with the resources.
When the user runs the blueprint this file will be output to their terminal once the
run command completes
Set a title for your blueprint
Set the author for your blueprint
Set the slug for your blueprint
Define environment variables which are required when interacting with your blueprint. Due to restrictions on the way that Unix systems handle shell sessions and environment variables it is not possible to automatically set envrionment variables as part of a
shipyard run. Instead; environment varaibles which are defined in an env block are output in the OS specific format so that they can be set using a separate command, e.g.
Semantic version string relating to the version of Shipyard which this blueprint is compatable with.
0.1.0 Shipyard has the capability to automatically install and run other versions of Shipyard to allow compatibility between the version of Shipyard a blueprint was design for and the verison installed. If the user does not have a compatible version of shipyard installed they will be prompted to download and install the correct version. The original version of Shipyard is not overwritten, additional versions are stored in
browser_windows is a comma separated string of URLs to open in the browser once a run completes. This parameter can be used in addition to the
open_in_browser resource parameter to open URLs not defined by a resource.