changelog.cmd

:dart: changelog.cmd: generate your changelog in a flexible way :dart:

GitHub Workflow Status

Project Homepage

Table of Content

  • Introduction
  • How to Use
  • How Contribute
  • License

Introduction

changelog_cmd is a command line tools that provide a collection of method to generate the changelog from a commit metadata.

The command line tools use the changelog_lib package to build the changelog, and provide som storing format like markdown.

The changelog extraction methods provided are:

  • header: Extract information from the header, and the header format is described here
  • metadata: Extract information from the body of the commit, and the body format is described here
  • more? please open a PR and provide a new one

Usage

TODO: adding how to download it!

To run the application it is possible to use the following command

# how to you it 
changelod-cli -p graphql-flutter -v v5.0.2-beta.7 -g zino-hofmann/graphql-flutter -b main
cat CHANGELOG.md
# see changelog --help for other information!

Additional information

The tool is open sto suggestion or improvement and also if you like to support the project, please consider donating.

License

Copyright 2022 Vincenzo Palazzo <vincenzopalazzodev@gmail.com>. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.
    * Neither the name of Google Inc. nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Libraries

config_manager
config_model
config model container the model class of the configuration.
constant
generator_mediator
Generator mediator contains all the generation method supported by the changelog command line
get_last_commits.graphql
git_cmd_fectcher
github_fetcher
Github fetcher use the Github API to fetch the commit list between two tags and return the list of commits inside the dart wrapper.
header_msg
Header Msg is the method generator to generate the changelog from the message header like this example here https://github.com/invertase/melos/blob/main/packages/melos/CHANGELOG.md
last_tag.graphql
markdown_printer
metadata_msg
Metadata MSG is a generation method used to extract the changelog from a list of commits with the help of the metadata.
method_generation
Method Generator is the interface to implement different method generation for the Changelog.
printer_interface
printer interface implement the generic interface for a changelog printer.
printer_mediator
schema.docs.graphql
semver_v2_msg
Header Msg is the method generator to generate the changelog from the message header like this example here https://github.com/invertase/melos/blob/main/packages/melos/CHANGELOG.md