Skip to content

Commit da29a8b

Browse files
committed
Add README
1 parent 115c972 commit da29a8b

File tree

1 file changed

+64
-1
lines changed

1 file changed

+64
-1
lines changed

README.md

+64-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# sd-step
1+
# sd-step
2+
[![Build Status][build-image]][build-url]
3+
[![Latest Release][version-image]][version-url]
4+
[![Go Report Card][goreport-image]][goreport-url]
5+
6+
> Wrapper command of habitat for Screwdriver
7+
8+
## Usage
9+
10+
```bash
11+
$ go get github.com/screwdriver-cd/sd-step
12+
$ cd $GOPATH/src/github.com/screwdriver-cd/sd-step
13+
$ go build -a -o sd-step
14+
$ ./sd-step --help
15+
NAME:
16+
sd-step - wrapper command of habitat for Screwdriver
17+
18+
USAGE:
19+
sd-step command arguments [options]
20+
21+
VERSION:
22+
0.0.0
23+
24+
COMMANDS:
25+
exec Install and exec habitat package with pkg_name and command...
26+
help, h Shows a list of commands or help for one command
27+
28+
GLOBAL OPTIONS:
29+
--pkg-version value Package version which also accepts semver expression
30+
--hab-channel value Install from the specified release channel (default: "stable")
31+
--help, -h show help
32+
--version, -v print the version
33+
34+
COPYRIGHT:
35+
(c) 2017 Yahoo Inc.
36+
$ ./sd-step exec core/node "node -v"
37+
v8.9.0
38+
$ ./sd-step exec --pkg-version "~6.11.0" core/node "node -v"
39+
v6.11.5
40+
$ ./sd-step exec --pkg-version "^6.0.0" core/node "node -v"
41+
v6.11.5
42+
$ ./sd-step exec --pkg-version "4.2.6" core/node "node -v"
43+
v4.2.6
44+
$ ./sd-step exec --pkg-version "~6.9.0" --hab-channel "unstable" core/node "node -v"
45+
v6.9.5
46+
```
47+
48+
## Testing
49+
50+
```bash
51+
$ go get github.com/screwdriver-cd/sd-step
52+
$ go test -cover github.com/screwdriver-cd/sd-step/...
53+
```
54+
55+
## License
56+
57+
Code licensed under the BSD 3-Clause license. See LICENSE file for terms.
58+
59+
[version-image]: https://img.shields.io/github/tag/screwdriver-cd/sd-step.svg
60+
[version-url]: https://github.com/screwdriver-cd/sd-step/releases
61+
[build-image]: https://cd.screwdriver.cd/pipelines/150/badge
62+
[build-url]: https://cd.screwdriver.cd/pipelines/150
63+
[goreport-image]: https://goreportcard.com/badge/github.com/Screwdriver-cd/sd-step
64+
[goreport-url]: https://goreportcard.com/report/github.com/Screwdriver-cd/sd-step

0 commit comments

Comments
 (0)