Githubrelease

=====

CLI
---

* Add validation for the REPOSITORY argument. Report an informative message if user
omitted it.

* Support customization of the GitHub API URL by passing ``--github-api-url`` parameter or by setting the
``GITHUB_API_URL`` environment variable.
See [PR57](https://github.com/j0057/github-release/pull/57). Contributed by [furlongm](https://github.com/furlongm)

* ``release`` command:

* ``release-notes``: Report a meaningful error if user omitted to set ``EDITOR`` env. variable.


Python API
----------

* Add ``github_api_url`` and `set_github_api_url`. See [61](https://github.com/j0057/github-release/issues/61).


Features (CLI and Python API)
-----------------------------

* ``release`` command:

* `delete`:

* Add support for ``--release-type`` and ``--older-than``. Fix issue [50](https://github.com/j0057/github-release/pull/50). Contributed by [Flamefire](https://github.com/Flamefire).


Issues (CLI and Python API)
---------------------------

* Fix click 8 support using ``ProgressBar.length is not None`` instead of the obsolete ``ProgressBar.length_known``. Contributed by [rly](https://github.com/rly)

* ``release`` command:

* ``create`` command:

* Do not attempt to upload assets on release create if none provided. See issue [68](https://github.com/j0057/github-release/issues/68). Contributed by [rly](https://github.com/rly)

* ``release-notes``:

* Fix use python 3 support

* ``delete`` command:

* Speed-up release deletion. See [PR51](https://github.com/j0057/github-release/pull/51). Contributed by [Flamefire](https://github.com/Flamefire)

* ``edit`` command:

* Explicitly check if body exceed maximum size.

Issues (Python API)
-------------------

* ``get_releases``: Add [backoff](https://github.com/litl/backoff#readme) decorator for retrying call in case of unresponsive GitHub API. Contributed by [owais](https://github.com/owais) following original idea from [dgerosa](https://github.com/dgerosa).

* ``get_release``: Add [backoff](https://github.com/litl/backoff#readme) decorator for retrying call in case the release was just created and
the GitHub response is not yet updated. Fix issue [67](https://github.com/j0057/github-release/pull/67). Contributed by [rly](https://github.com/rly) and suggested by [owais](https://github.com/owais).

=====

Features (CLI and Python API)
-----------------------------

* ``release`` command:

* ``create``:

* Add support for ``--body``. Contributed by [bstansell](https://github.com/bstansell) and suggested by [mortenlj](https://github.com/mortenlj).

Documentation
-------------

* Improve README section [maintainers: how to make a release ?](./README.mdmaintainers-how-to-make-a-release-)

Testing
-------

* Fix tests when no VERSION file exists. See [PR44](https://github.com/j0057/github-release/pull/44). Contributed by [lucasbrunialti](https://github.com/lucasbrunialti).
* flake8: Increase max line length from 80 to 120.

=====

Features (CLI and Python API)
-----------------------------

* ``release`` command:

* ``edit``:

* Add ``--publish`` flag having opposite effect of ``--draft``
* Add ``--release`` flag having opposite effect of ``--prerelease``

Python API
----------

* Add ``gh_commit_get`` allowing to commit properties or check if a commit exists.

=====

Issues (CLI and Python API)
---------------------------

* ``release`` command:

* ``edit``: If any, remove leftover temporary tag and
avoid ``Release with tag_name latest-tmp not found`` exception.

=====

Features (CLI and Python API)
-----------------------------

* Support projects having more than 30 assets, releases or refs.

* Introduce dependency to [LinkHeader](https://pypi.python.org/pypi/LinkHeader/) python
package to handle [GitHub pagination information](https://developer.github.com/v3/guides/traversing-with-pagination/).

=====

Features (CLI and Python API)
-----------------------------

* ``ref`` command:

* ``list``: Consolidate tags listing using [refs and refs/tags](https://developer.github.com/v3/git/refs/#get-all-references)
endpoints. In practice, we observed that tags can be listed with one or the other.