amo-changelog (1)

Leading comments

Copyright (c) 2014 Ximin Luo <infinity0@pwned.gg>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDI...

(The comments found at the beginning of the groff file "man1/amo-changelog.1".)

NAME

amo-changelog - fetch Version History of an addon

SYNOPSIS

amo-changelog [options] extension

DESCRIPTION

amo-changelog fetches the Version History of an addon from the Mozilla Extensions website. It is meant to offer an easy way to include upstream changelogs in Debian packages of mozilla extensions - in many cases, this is not contained in the upstream source code repository, but is available on said website.
The extension argument is its short name, as used by the website. For example, the homepage for "Adblock Plus" is addons.mozilla.org/en-US/firefox/addon/adblock-plus so the short name would be "adblock-plus".
Here is an example for debian/rules:
# if using debhelper
override_dh_installchangelogs:
       dh_installchangelogs debian/upstream/changelog.html debian/upstream/changelog

[char46]PHONY: get-orig-changelog
get-orig-changelog:
       amo-changelog -p rst adblock-plus

Using this approach, one would save the output files debian/upstream/{changelog.html,changelog} as part of the Debian packaging. When updating the package with a new upstream release, one would run `debian/rules get-orig-changelog`

OPTIONS

-h, --help

Display a brief help message.

-f, --html-file

File to write to. Default: debian/upstream/changelog.html

-p, --plain-format

Generate a human-readable form of the changelog in the file without the .html extension, using an external program. Possible options are text (uses lynx(1)), markdown (pandoc(1)), or rst (pandoc(1)). Default: none.

AUTHOR

Jakub Wilk <jwilk@debian.org> and Ximin Luo <infinity0@pwned.gg>