Contributing

Thank you for considering contributing! There are many ways you can help.

Bugs/Feature Requests

File an issue if you think you’ve found a bug or would like to request a feature. Be sure to describe:

  1. How it can be reproduced
  2. What did you expect to happen?
  3. What actually happened?
  4. Version, platform, etc. if relevant

You can file all issues with Screwdriver in the screwdriver repo; please tag with appropriate Github labels whenever possible. We will update any issues we’re working on with a daily summary. To see what we’re currently working on, you can check out our digital scrum board in the Projects section of the Screwdriver API repo.

Submitting Pull Requests

Patches for fixes, features, and improvements are accepted through pull requests.

Please ask before embarking on a large improvement so you’re not disappointed if it does not align with the goals of the project or owner(s).

Commit Message Format

We use semantic-release, which requires commit messages to be in this specific format: <type>(<scope>): <subject>

Keyword Description
Type feat (feature), fix (bug fix), docs (documentation), style (formatting, missing semi colons, …), refactor, test (when adding missing tests), chore (maintain)
Scope anything that specifies the scope of the commit; can be blank, the issue number that your commit pertains to, or *
Subject description of the commit

Important: For any breaking changes that require a major version bump, add BREAKING CHANGE somewhere in the commit title or message.

Examples commit titles:

Where to Contribute

Screwdriver has a modular architecture, and the various responsibilities are split up into separate repos.

Check out the architecture diagram to see the overall workflow of Continuous Delivery using Screwdriver. The next few sections will help lay out where different code repositories fit.

Screwdriver API

The screwdriver repo is the core of screwdriver, providing the API endpoints for everything that screwdriver does. The API is based on the hapijs framework and is implemented in node as a series of plugins.

Launcher

The launcher performs step execution and housekeeping internal to build containers. This is written in Go and mounted into build containers as a binary.

Executors

An executor is used to manage build containers for any given job. Several implementations of executors have been created. All are designed to follow a common interface. Executor implementations are written in node:

The executor router is a generic executor plugin that routes builds to a specified executor.

Models

The object models provide the definition of the data that is saved in datastores (analogous to databases). This is done in two parts:

Datastores

A datastore implementation is used as the interface between the API and a data storage mechanism. There are several implementations written in node around a common interface.

Artifacts

The Artifact Store (not to be confused with the datastores mentioned above) is used for saving log outputs, shared steps, templates, test coverage, and any artifacts that are generated during a build. The log service is a Go tool for reading logs from the Launcher and uploading them to the store. The artifact-bookend is used for uploading artifacts to the store.

Source Code Management

An SCM implementation is used as the interface between the API and an SCM. There are several implementations written in nodejs around a common interface.

Templates

Templates are snippets of predefined code that people can use to replace a job definition in their screwdriver.yaml. A template contains a series of predefined steps along with a selected Docker image.

Config Parser

Node module for validating and parsing user’s screwdriver.yaml configurations.

Guide & Homepage

The Guide is documentation! Everything you ever hoped to know about the Screwdriver project. The Homepage is the basic one-pager that powers Screwdriver.cd.

UI

The Ember-based user interface of Screwdriver.

Miscellaneous Tools

Adding a New Screwdriver Repo

We have some tools to help start out new repos for screwdriver:

If you create a new repo, please come back and edit this page so that others can know where your repo fits in.

Screwdriver.cd Tests and Examples

The organization screwdriver-cd-test contains various example repos/screwdriver.yamls and acceptance tests for Screwdriver.cd.