Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,9 @@ by setting `'release-script'.skipBuildStep` option:
}
```

####Skip publishing
If you don't want to publish your package in `npm`, `bower` or `github` make sure to have the package marked as `private` or set `skipPublishing` options to true in `release-script`

#### Options

All options for this package are kept under `'release-script'` node in your project's `package.json`
Expand All @@ -140,6 +143,10 @@ All options for this package are kept under `'release-script'` node in your proj
- `tmpBowerRepo` - the folder name for temporary files for bower pkg.
- `default` value: `'tmp-bower-repo'`
- `altPkgRootFolder` - the folder name for alternative npm package's root folder
- `skipBuildStep` - will skip the build step during the release
- `default` value: `false`
- `skipPublishing`
- `default` value: `false`

It is advised to add `bowerRoot` and `tmpBowerRepo` folders to your `.gitignore` file.

Expand All @@ -149,7 +156,9 @@ Example:
"bowerRepo": "git@github.com:<org-author-name>/<name-of-project>-bower.git",
"bowerRoot": "amd",
"tmpBowerRepo": "tmp-bower-repo",
"altPkgRootFolder": "lib"
"altPkgRootFolder": "lib",
"skipBuildSte": false,
"skipPublishing": false
}
```

Expand Down Expand Up @@ -212,7 +221,7 @@ Then to actually run your commands you will have to add `--run`.
- if `docsRepo` option is set then documentation pages are being pushed to their repo.
It is done the same way as `bower` publishing process.

If `--only-docs` command line option is set then `github`, `npm` and `bower` publishing steps will be skipped.
If `--only-docs` or `--skip-publishing` command line option is set then `github`, `npm` and `bower` publishing steps will be skipped.

## Installation

Expand Down
Loading