JSPM

@atomist/automation-client-ext-dashboard

0.1.0-20180613153605
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 15
  • Score
    100M100P100Q102896F
  • License Apache-2.0

Extension for sending Dashboard workspace and user notifications

Package Exports

  • @atomist/automation-client-ext-dashboard

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@atomist/automation-client-ext-dashboard) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@atomist/automation-client-ext-dashboard

An extension to an Atomist automation-client to forward Slack messages (DM or channel messages) to the Atomist Dashboard running at https://app.atomist.com.

Usage

  1. First install the dependency in your automation-client project
$ npm install @atomist/automation-client-ext-dashboard
  1. Install the support in your atomist.config.ts
import { configureDashboardNotifications } from "@atomist/automation-client-ext-dashboard";

export const configuration: Configuration = {
    postProcessors: [
        configureDashboardNotifications,
    ],
}

Support

General support questions should be discussed in the #support channel on our community Slack team at atomist-community.slack.com.

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 install all the required packages
npm run build lint, compile, and test
npm run lint run tslint against the TypeScript
npm run compile compile all TypeScript into JavaScript
npm test run tests and ensure everything is working
npm run clean remove stray compiled JavaScript files and build directory

Release

To create a new release of the project, update the version in package.json and then push a tag for the version. The version must be of the form M.N.P where M, N, and P are integers that form the next appropriate semantic version for release. The version in the package.json must be the same as the tag. For example:

$ npm version 1.2.3
$ git tag -a -m 'The ABC release' 1.2.3
$ git push origin 1.2.3

The Travis CI build (see badge at the top of this page) will publish the NPM module and automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes.


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