LOVE 1097 - Blueprint skeleton

[sffortytwo]

Definition of Done

This is the definition of done for (new and modified) blueprints to be accepted into the central XebiaLabs blueprints repository.

Value

This section describes how to determine whether a blueprint has enough value to be included in the central XebiaLabs blueprints repository.

• The blueprint applies to a focused use case.
• The blueprint uses at least one XebiaLabs product.
• The blueprint depends on as few other products as possible. N.B.: This is part of the definition of done to keep the blueprint focused and applicable to as many users as possible. A blueprint that depends on one specific CI tool and one specific Java EE application server and one specific ticketing system can only be used by users that have all three products.
• The blueprint can be used with content supplied by the user but also includes demo content. A blueprint that does not work with content supplied by the user is a demo or a showcase and does not help the user with their own work.

Technical

This section describes how to determine whether the blueprint has the right technical quality to be included in the central XebiaLabs blueprints repository.

• The branch from which the PR is created is up-to-date with the development branch.
• The blueprint contains a README.md file at the root of the blueprint folder that describes the blueprint, using the README template in the .github folder of this repository.
• The blueprint generates a xebialabs/USAGE.md file which, at a minimum, explains how to use the blueprint after it is generated (like adding any missing steps, creating accounts, setting up Docker containers, applying the YAML using xl CLI, running release. etc.). N.B.: Do not use this document to describe how to instantiate the blueprint. It will only be available to the user after the blueprint has been instantiated.
• If the blueprint depends on external products that can be started as a Docker container, the blueprint generates a docker/docker-compose.yml file so that it can be tested without having to manually install those products. Do not use this Docker Compose file to start XL Deploy, XL Release, Docker or Kubernetes.
• The blueprint does not contain sensitive information such passwords, tokens, credentials or licenses.
• The blueprint uses secret: true in the blueprint.yaml parameter definition for question that ask for sensitive information.
• The blueprint does not contain the files xebialabs/.gitignore, xebialabs/values.xlvals and xebialabs/secrets.xlvals and does not refer to them from the files section of the blueprint.yaml file. These files will be generated when the blueprint is instantiated. To generate the xebialabs/values.xlvals file, use the saveInXlVals: true directive in the parameters section of the blueprint. To generate the xebialabs/secrets.xlvals file, use the secret: true directive .
• The blueprint does not define parameters for trivial things like phase names, task names, folder names etc. Ask questions that add value and be opinionated where possible. For example, ask for a project name and derive folder names, task names etc from that.
• Folder and file names must use kebab-case, for example: aws/sample-app-demo, xld-environment.yaml

Review and testing

This section describes how to determine whether the blueprint has been reviewed and tested well enough to be included in the central XebiaLabs blueprints repository.

• Unit test is added in a __test__ folder for each blueprint. Refer the CONTRIBUTING.md file at the root of of this repository for more details.
• The Travis CI for the PR is green
• The blueprint has been reviewed by someone else in the team.
• Both README and USAGE files have been reviewed by a technical writer and a product marketing manager.
• The blueprint has been manually tested with the docker/docker-compose.yml that is generated as part of it.
• The blueprint works on Linux, Mac and Windows.

[deepu105]

can be {{.BlueprintName | uppercase}}

[sffortytwo]

Using {{.BlueprintName | replace "-" " " | title}}

[sffortytwo]

This turns my-amazing-blueprint into My Amazing Blueprint

[deepu105]

use {{.Description}}

[sffortytwo]

Done

[deepu105]

should be {{.BlueprintName}}

[sffortytwo]

Done

[deepu105]

won't be needed in the generated app I suppose

[sffortytwo]

Agreed