README.md

Templates Plugin

Hapi templates plugin for the Screwdriver API

Usage

Register plugin

const Hapi = require('@hapi/hapi');
const server = new Hapi.Server();
const templatesPlugin = require('./');

server.connection({ port: 3000 });

server.register({
    register: templatesPlugin,
    options: {}
}, () => {
    server.start((err) => {
        if (err) {
            throw err;
        }
        console.log('Server running at:', server.info.uri);
    });
});

Routes

Template

Get all templates

GET /templates

Can filter by template namespace: GET /templates?namespace=chef

Can search by keyword in template name, namespace, and description: GET /templates?search=screwdriver

Can list all distinct template namespaces: GET /templates?distinct=namespace

Can use additional options for sorting and pagination: GET /templates?sort=ascending&sortBy=name&page=1&count=50

Get a single template

You can get a single template by providing the template name and the specific version or the tag.

GET /templates/{name}/{tag} or GET /templates/{name}/{version}

Arguments

'name', 'tag' or 'version'

• name - Name of the template
• tag - Tag of the template (e.g. stable, latest, etc)
• version - Version of the template

Create a template

Creating a template will store the template data (config, name, version, description, maintainer) into the datastore.

version will be auto-bumped. For example, if [email protected] already exists and the version passed in is 1.0.0, the newly created template will be version 1.0.1.

Note: This endpoint is only accessible in build scope and the permission is tied to the pipeline that first creates the template.

POST /templates

Arguments

'name', 'namespace', 'version', 'description', 'maintainer', 'labels'

• name - Name of the template
• namespace - (Optional) Namespace of the template
• version - Version of the template
• description - Description of the template
• maintainer - Maintainer of the template
• labels - Labels of the template. This field is optional and should be an array.
• config - Config of the template. This field is an object that includes steps, image, and optional secrets, environments. Similar to what's inside the job

Example payload:

{
  "name": "build",
  "namespace": "screwdriver",
  "labels": ["stable"],
  "version": "1.7.3",
  "description": "this is a template",
  "maintainer": "[email protected]",
  "config": {
      "steps": [{
          "echo": "echo hello"
      }]
  }
}

Delete a template

Deleting a template will delete a template and all of its associated tags and versions.

DELETE /templates/{name}

Arguments

• name - Name of the template

Template Tag

Template tag allows fetching on template version by tag. For example, tag [email protected] as stable.

Create/Update a tag

If the template tag already exists, it will update the tag with the new version. If the template tag doesn't exist yet, this endpoint will create the tag.

Note: This endpoint is only accessible in build scope and the permission is tied to the pipeline that creates the template.

PUT /templates/{templateName}/tags/{tagName} with the following payload

• version - Exact version of the template (ex: 1.1.0)

Delete a tag

Delete the template tag. This does not delete the template itself.

Note: This endpoint is only accessible in build scope and the permission is tied to the pipeline that creates the template.

DELETE /templates/{templateName}/tags/{tagName}