Commands

Running from cli

• -o, --old: Specify the first pack to compare.
• -n, --new: Specify the pack to compare against.
• -c, --config: Use a config file
  • new creates a new one.
• -f, --file: Specify the output file for the changelog
  • console prints the changelog to the console.
• -v, --version: Print the version number

Warning

-n becomes mandatory when -o is specified and vice versa

Running as a module/function

generate_changelog(old_pack, new_pack, config, changelog_file)

• old_pack: string of the path of the first pack to compare
• new_pack: string of the path of the pack to compare against
• config: string of the path of the config file, non uses the default config
• changelog_file: string of the path of the output file for the changelog. None will write the changelog to a file named Changelog.md in the working dir
  • console prints the changelog to the console.
  • unformatted returns 3 arrays (added, updated and removed elements)
  • formatted returns a string containing the already made changelog