1 | # @atomist/sdm-pack-docker
|
2 |
|
3 | [![atomist sdm goals](http://badge.atomist.com/T29E48P34/atomist/sdm-pack-docker/275b4284-9942-41c8-9b91-e90957d99188)](https://app.atomist.com/workspace/T29E48P34)
|
4 | [![npm version](https://img.shields.io/npm/v/@atomist/sdm-pack-docker/next.svg)](https://www.npmjs.com/package/@atomist/sdm-pack-docker/v/next)
|
5 |
|
6 | [Atomist][atomist] software delivery machine (SDM) extension Pack for an Atomist SDM to integrate [docker](https://www.docker.io).
|
7 |
|
8 | See the [Atomist documentation][atomist-doc] for more information on
|
9 | what SDMs are and what they can do for you using the Atomist API for
|
10 | software.
|
11 |
|
12 | [atomist-doc]: https://docs.atomist.com/ (Atomist Documentation)
|
13 |
|
14 | ## Usage
|
15 |
|
16 | TODO
|
17 |
|
18 | ## Support
|
19 |
|
20 | General support questions should be discussed in the `#support`
|
21 | channel in the [Atomist community Slack workspace][slack].
|
22 |
|
23 | If you find a problem, please create an [issue][].
|
24 |
|
25 | [issue]: https://github.com/atomist/sdm-pack-docker/issues
|
26 |
|
27 | ## Development
|
28 |
|
29 | You will need to install [Node][node] to build and test this project.
|
30 |
|
31 | [node]: https://nodejs.org/ (Node.js)
|
32 |
|
33 | ### Build and test
|
34 |
|
35 | Use the following package scripts to build, test, and perform other
|
36 | development tasks.
|
37 |
|
38 | Command | Reason
|
39 | ------- | ------
|
40 | `npm install` | install project dependencies
|
41 | `npm run build` | compile, test, lint, and generate docs
|
42 | `npm run lint` | run TSLint against the TypeScript
|
43 | `npm run compile` | generate types from GraphQL and compile TypeScript
|
44 | `npm test` | run tests
|
45 | `npm run autotest` | run tests every time a file changes
|
46 | `npm run clean` | remove files generated during build
|
47 |
|
48 | ### Release
|
49 |
|
50 | Releases are handled via the [Atomist SDM][atomist-sdm]. Just press
|
51 | the 'Approve' button in the Atomist dashboard or Slack.
|
52 |
|
53 | [atomist-sdm]: https://github.com/atomist/atomist-sdm (Atomist Software Delivery Machine)
|
54 |
|
55 | ---
|
56 |
|
57 | Created by [Atomist][atomist].
|
58 | Need Help? [Join our Slack workspace][slack].
|
59 |
|
60 | [atomist]: https://atomist.com/ (Atomist - How Teams Deliver Software)
|
61 | [slack]: https://join.atomist.com/ (Atomist Community Slack)
|
62 |
|
63 | [atomist]: https://atomist.com/ (Atomist - Development Automation)
|
64 | [slack]: https://join.atomist.com/ (Atomist Community Slack)
|