/ 
App-CPAN-Changes-0.004
River stage one • 1 direct dependent • 1 total dependent
/ cpan-changes

NAME

cpan-changes - CLI for CPAN::Changes

VERSION

This document describes version 0.004 of cpan-changes (from Perl distribution App-CPAN-Changes), released on 2021-05-26.

SYNOPSIS

Check syntax:

% cpan-changes check -f Changes
% cpan-changes check ;# by default try to search file Changes, CHANGELOG, etc

Parse and dump parse result as JSON structure:

% cpan-changes dump

Get preamble:

% cpan-changes preamble

Set new preamble:

% cpan-changes preamble "Revision history of Foo-Bar"

See information about a particular release:

% cpan-changes release 0.001

Add a new release:

% cpan-changes add-release 0.002 2016-10-10 "Change 1" "[GROUP 1]" "Change 2"

# ditto, but dry-run and will show the resulting Changes file
% cpan-changes add-release -V 0.002 --date 2016-10-10 --change "Change 1" \
    --change "[GROUP 1]" --change "Change 2" --dry-run

More subcommands to be added.

SUBCOMMANDS

add-release

Add a new release.

check

Check for parsing errors in Changes file.

dump

Dump Changes as JSON structure.

preamble

Get/set preamble.

release

Return information (JSON object dump) of a specific release.

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--file=s, -f

If not specified, will look for file called Changes/CHANGELOG/etc in current directory.

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--no-config, -C

Do not use any configuration file.

--no-env

Do not read environment for default options.

--page-result

Filter output through a pager.

--subcommands

List available subcommands.

--version, -v

Display program's version and exit.

--view-result

View output using a viewer.

Options for subcommand add-release

--change=s@*

Can be specified multiple times.

--changes-json=s

See --change.

--date=s*
--note=s
--version-arg=s*, -V

Options for subcommand preamble

--preamble=s

Set new preamble.

Options for subcommand release

--version-arg=s*

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C cpan-changes cpan-changes

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete cpan-changes 'p/*/`cpan-changes`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/cpan-changes.conf, ~/cpan-changes.conf, or /etc/cpan-changes.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

Common for all subcommands

file (see --file)
format (see --format)
naked_res (see --naked-res)

Configuration for subcommand add-release

changes (see --change)
date (see --date)
note (see --note)
version (see --version-arg)

Configuration for subcommand check

Configuration for subcommand dump

Configuration for subcommand preamble

preamble (see --preamble)

Configuration for subcommand release

version (see --version-arg)

ENVIRONMENT

CPAN_CHANGES_OPT => str

Specify additional command-line options.

FILES

~/.config/cpan-changes.conf

~/cpan-changes.conf

/etc/cpan-changes.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CPAN-Changes.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CPAN-Changes.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-App-CPAN-Changes/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

CPAN::Changes

changes from Module::Changes

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2017, 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.