Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
graphql
scripts
src
test
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
_config.yml
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

projects/my-company-automations

This repository contains examples demonstrating use of the Atomist API. You will find examples illustrating:

  • Creating bot commands using command handlers
  • Responding to DevOps events, e.g., commits pushed to a repository, using event handlers

These examples use the @atomist/automation-client node module to implement a local client that connects to the Atomist API.

Prerequisites

Access to our lab

To get access to this lab, please register to Ivan's Slack team.You'll receive an invitation.

Node.js

You will need to have Node.js installed. To verify that the right versions are installed, please run:

$ node -v
v8.4.0
$ npm -v
5.4.1

Cloning the repository and installing dependencies

To get started run the following commands to clone the project, install its dependencies, and build the project:

$ git clone git@github.com:ivans-innovation-lab/my-company-automations.git
$ cd my-company-automations
$ npm install
$ npm run build

Configuring your environment

If this is the first time you will be running an Atomist API client locally, you should first configure your system using the atomist-config script:

$ `npm bin`/atomist config [SLACK_TEAM_ID]

The script does two things: records what Slack team you want your automations running in and creates a GitHub personal access token with "read:org" scope. You should add "repo" scopes to that token on Github, so your commands can change/add the repos.

You must run the automations in a Slack team of which you are a member. You can get the Slack team ID by typing team in a DM to the Atomist Bot. If you do not supply the Slack team ID on the command line, the script will prompt you to enter it.

The atomist-config script will prompt you for your GitHub credentials. It needs them to create the GitHub personal access token. Atomist does not store your credentials and only writes the token to your local machine.

The Atomist API client authenticates using a GitHub personal access token. The Atomist API uses the token to confirm you are who you say you are and are in a GitHub org connected to the Slack team in which you are running the automations. In addition, the Atomist API only allows members of the GitHub team atomist-automation to authenticate and register a new client. You will have to create a team in your GitHub organization named atomist-automation and add the users who want to create and register automations to it.

Starting up the automation-client

To start the client, run the following command:

$ npm run autostart

Invoking a command handler from Slack

Hello world

This project contains the code to create and respond to a simple hello world bot command. The code that defines the bot command and implements responding to the command, i.e., the command handler, can be found in HelloWorld.ts. Once you have your local automation client running (npm run start), you can invoke the command handler by sending the Atomist bot the command in the #general channel:

@atomist hello world

Once you've submitted the command in Slack, you'll see the incoming and outgoing messages show up in the logs of your locally running automation-client. Ultimately, you should see the response from the bot in Slack.

Command/Domain side project generator

This project contains the code to create and respond to a simple generate command side API bot command. The code that defines the bot command and implements responding to the command, i.e., the command handler, can be found in commandSideGenerator.ts. Once you have your local automation client running (npm run start), you can invoke the command handler by sending the Atomist bot the command in the #general channel:

@atomist generate command side API

Once you've submitted the command in Slack, you'll see the incoming and outgoing messages show up in the logs of your locally running automation-client. Ultimately, you should see the response from the bot in Slack, asking you for some of the parameters for your new 'command side' project on Github.

Support

If you find a problem, please create an issue.

Development

You will need to install node to build and test this project.

Build and Test

Command Reason
npm install to install all the required packages
npm start to start the Atomist automation client
npm run autostart run the client, refreshing when files change
npm run lint to run tslint against the TypeScript
npm run compile to compile all TypeScript into JavaScript
npm test to run tests and ensure everything is working
npm run autotest run tests continuously
npm run clean remove stray compiled JavaScript files and build directory

Created by Ivan Dugalic@lab. Need Help? Join our Slack team.