@atomist/samples v0.1.0-master.20190530193224

@atomist/samples

This repository is the home of very small sample Atomist Software Delivery Machines. Each TypeScript file in the root of this repository show-cases a certain feature of the SDM framework and the Atomist platform.

Software delivery machines enable you to control your delivery process in code. Think of it as an API for your software delivery. See the Atomist documentation for more information on the concept of a software delivery machine and how to create and develop an SDM.

Running the Samples

Before you can run any of the samples from this repository you need to install the Atomist CLI. Plese follow Developer Quick Start to set up your environment.

Once the Atomist CLI is installed, you run any of the examples by simply typing the following into your terminal:

$ atomist start --repository-url=https://github.com/atomist/samples.git --index=<SAMPLE_FILE>

Running this command requires you replace the placeholder <SAMPLE_FILE> with a name of one of the sample SDM programs in the root of this repository.

Here is a list of possible samples you can run:

Contributing

Contributions to this project from community members are encouraged and appreciated. Please review the Contributing Guidelines for more information. Also see the Development section in this document.

Code of conduct

This project is governed by the Code of Conduct. You are expected to act in accordance with this code by participating. Please report any unacceptable behavior to code-of-conduct@atomist.com.

Documentation

Please see docs.atomist.com for developer documentation.

Connect

Follow @atomist and the Atomist blog.

Support

General support questions should be discussed in the #support channel in the Atomist community Slack workspace.

If you find a problem, please create an issue.

Development

You will need to install Node.js to build and test this project.

Build and test

Install dependencies.

$ npm install

Use the build package script to compile, test, lint, and build the documentation.

$ npm run build

Release

Releases are handled via the Atomist SDM. Just press the 'Approve' button in the Atomist dashboard or Slack.

Created by Atomist. Need Help? Join our Slack workspace.