@cox-automotive/yaml-changelog
v0.1.9
Published
A simple cli tool for creating and adding to a project's yaml formatted changelog
Downloads
72
Keywords
Readme
yaml-changelog
A simple cli tool for creating and adding to a project's yaml formatted changelog
Usage
$ npm install -g @cox-automotive/yaml-changelog
$ yaml-changelog COMMAND
running command...
$ yaml-changelog (-v|--version|version)
@cox-automotive/yaml-changelog/0.1.8 darwin-x64 node-v10.15.3
$ yaml-changelog --help [COMMAND]
USAGE
$ yaml-changelog COMMAND
...
Commands
yaml-changelog add
yaml-changelog diff
yaml-changelog filter [DATE]
yaml-changelog help [COMMAND]
yaml-changelog init [PROJECT]
yaml-changelog release [DATE]
yaml-changelog render [FILE]
yaml-changelog render-release [FILE]...
yaml-changelog add
Adds a document to changelog.yaml containing a username, story number (optional) and description of changes.
USAGE
$ yaml-changelog add
OPTIONS
-h, --help show CLI help
See code: src/commands/add.ts
yaml-changelog diff
Compares the changelog against the previous revision, HEAD of a given branch, or given commit hash
USAGE
$ yaml-changelog diff
OPTIONS
-b, --branch=branch branch to compare against
-c, --count only output the number of changes difference between revs
-h, --help show CLI help
-r, --revision=revision commit hash to compare against
See code: src/commands/diff.ts
yaml-changelog filter [DATE]
Dislays all entries in the changelog after the provided date
USAGE
$ yaml-changelog filter [DATE]
ARGUMENTS
DATE A date in ISO 8601 format
OPTIONS
-h, --help show CLI help
See code: src/commands/filter.ts
yaml-changelog help [COMMAND]
display help for yaml-changelog
USAGE
$ yaml-changelog help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
yaml-changelog init [PROJECT]
Create an empty changelog.yaml
USAGE
$ yaml-changelog init [PROJECT]
ARGUMENTS
PROJECT Name of the project the changelog is being created in
OPTIONS
-h, --help show CLI help
See code: src/commands/init.ts
yaml-changelog release [DATE]
Regenerates releases.yaml with changes from changelog.yaml
USAGE
$ yaml-changelog release [DATE]
ARGUMENTS
DATE A date in ISO 8601 format
OPTIONS
-h, --help show CLI help
See code: src/commands/release.ts
yaml-changelog render [FILE]
Renders a given changelog to markdown
USAGE
$ yaml-changelog render [FILE]
ARGUMENTS
FILE Changelog file to render
OPTIONS
-h, --help show CLI help
See code: src/commands/render.ts
yaml-changelog render-release [FILE]...
Given a list of releases.yaml files, generates a single RELEASE_NOTES.md
USAGE
$ yaml-changelog render-release [FILE]...
ARGUMENTS
FILE releases.yaml to render
OPTIONS
-h, --help show CLI help
See code: src/commands/render-release.ts
Contributing
Prereqs
- Typescript
- TSLint
- OCLIF - Adding additional commands
- Yarn - Dependency management