adobe-changelog-generator's Introduction

Adobe Changelog Generator

Adobe Changelog Generator is the core package that is used to generate a changelog file.

Installation and update
Commands

Technical Requirements

Installation

$ aio plugins:install @adobe/aio-cli-plugin-changelog
# OR
$ aio discover -i

$ aio changelog --help...
$ aio config:set GITHUB_TOKEN=<personal access token>

Update

Please use the latest version of the plugin.
Use command aio plugins to see outdated plugins.
Use command aio plugins:update for update plugins to the latest stable version.

Commands

aio changelog:generate
aio changelog:generate-config-sample

`aio changelog:generate`

Changelog generation tool

Changelog generation tool

USAGE
  $ aio changelog:generate

OPTIONS
  -c, --config=config          Path to the configuration located on your local machine

  -n, --namespaces=namespaces  [default: ] Generate changelog for specific namespace, example:
                               organization/repository:branch

`aio changelog:generate-config-sample`

USAGE
  $ aio changelog:generate-config-sample

OPTIONS
  -t, --type=short|long        [default: Short] Type of generated config. 
                                    Short - minimum required configuration for application.
                                    Long - config with all possible parameters  

  -p, --path=path              [default: <directory from which app was executed>/config.json] 
                                    Path to generated config sample.