https://github.com/streamich/ci-scripts
Travis and CircleCI scripts
https://github.com/streamich/ci-scripts
Last synced: 11 months ago
JSON representation
Travis and CircleCI scripts
- Host: GitHub
- URL: https://github.com/streamich/ci-scripts
- Owner: streamich
- Created: 2018-04-26T23:13:33.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-07-25T21:10:24.000Z (11 months ago)
- Last Synced: 2025-08-04T10:11:05.040Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 381 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ci-scripts
Useful scripts to execute from your CI runner. For example,
post to Slack and GitHub when your build completes:
##### Install
```
npm install ci-scripts
```
##### CLI usage
```
ci slack
```
##### Node usage
```js
const {exec} = require('ci-scripts');
exec(['echo'], {message: 'It works'});
```
## Docs
##### Commands
- [`cmd`](./docs/cmd.md)
- [`echo`](./docs/echo.md)
- [`github-post`](./docs/github-post.md)
- [`github-upload`](./docs/github-upload.md)
- [`help`](./docs/help.md)
- [`readme`](./docs/readme.md)
- [`s3-upload`](./docs/s3-upload.md)
- [`slack`](./docs/slack.md)
- [`version`](./docs/version.md)
##### CLI Params
```
ci-scripts v0.10.0
Usage: ci [sub-command] [subsub-command] [options]
Use e.g. "ci slack --webhook=http://..." will post message to Slack".
See https://github.com/streamich/ci-scripts for more commands.
--config Path to configuration file [default: "ci.config.js"]
--plan, --dry-run Do not touch or write anything, but show the commands
--debug Print debug information
-h, --help Print this help
-v, --version Print version number
-V, --verbose Verbose output
```
##### `ci.config.js` File
Optionally, you can add a `ci.config.js` file to your project, see [config file reference](./docs/ci.config.md).