$ github_changelog_generator --help

unreleased=false
future-release=5.0.0
since-tag=1.0.0

export CHANGELOG_GITHUB_TOKEN="«ваш 40-значный токен GitHub»"

API rate limit exceeded for github_username.
See: https://developer.github.com/v3/#rate-limiting

require 'github_changelog_generator/task'

GitHubChangelogGenerator::RakeTask.new :changelog do |config|
  config.user = 'username'
  config.project = 'project-name'
  config.since_tag = '0.1.14'
  config.future_release = '0.2.0'
end
``` **Возможности и преимущества этого проекта**

Можно передать параметры в задачу `rake` как параметры конфигурации (`config`). И поскольку вы сами называете задачу `rake`, можно создать столько задач, сколько захотите.

Параметры имён можно найти в исходном коде парсера (#setup_parser) (https://github.com/github-changelog-generator/github-changelog-generator/blob/master/lib/github_changelog_generator/parser.rb). Например, чтобы перевести метку ошибок на португальский язык, вместо установки `config.bugs_label` необходимо установить `config.bug_prefix` и так далее.

* *Создание канонического аккуратного файла журнала изменений с разделами по умолчанию, которые соответствуют основным рекомендациям по ведению журнала изменений* (http://keepachangelog.com):
    * Опционально генерируйте **невыпущенные** изменения (закрытые проблемы, которые ещё не выпущены).
    * Поддержка **GitHub Enterprise** через параметры командной строки!
    * Гибкая настройка формата:
        * Настраивайте проблемы, которые **должны быть добавлены** в журнал изменений.
        * Поддерживаются **пользовательские форматы даты** (но помните об [ISO 8601](http://xkcd.com/1179/)!).
        * Вручную укажите версию, которая исправила проблему (для случаев, когда дата закрытия проблемы не совпадает), присвоив проблеме `milestone` то же имя, что и тег версии.
        * Автоматически **исключайте конкретные проблемы**, которые не имеют отношения к вашему журналу изменений (по умолчанию все проблемы с метками `question`, `duplicate`, `invalid` или `wontfix`).
    * **Различайте** проблемы **по меткам**:
        * Объединённые запросы на вытягивание (все объединённые запросы на вытягивание).
        * Исправления ошибок (проблемы с меткой `bug`).
        * Улучшения (проблемы с меткой `enhancement`).
        * Проблемы (закрытые проблемы без меток).

* Вручную включайте или исключайте проблемы по меткам.
* Настройте многое другое! Настройте журнал изменений в соответствии со своими предпочтениями. (*См. `github_changelog_generator --help` для получения подробной информации*).

**Использование функции сводного раздела**

Для каждой версии можно добавить сводку выпуска с текстом, изображениями, gif-анимациями и т. д., а также чётко показать пользователю новые функции и примечания. Это делается с помощью метаданных GitHub.

**Пример**: добавление сводки выпуска для v1.0.0:

1. Создайте новую проблему GitHub.
2. В поле «Описание» проблемы добавьте содержимое сводки выпуска.

3. Установите для проблемы метку `release-summary` и добавьте её в `milestone` GitHub `v1.0.0`.
4. Закройте проблему и выполните `github-changelog-generator`.
5. Результат выглядит следующим образом:
> ## [v1.0.0](https://github.com/github-changelog-generator/github-changelog-generator/tree/1.0.0) (2014-11-07)
> [Полный журнал изменений](https://github.com/github-changelog-generator/github-changelog-generator/compare/0.1.0...1.0.0)
>
> ![image](https://user-images.githubusercontent.com/12690315/45935880-006a8200-bfeb-11e8-958e-ff742ae66b96.png)
>
> Hello, World! :tada:
>
> **Реализованные улучшения:**
> - Добавить некоторые функции

**Альтернативы**

Вот [список вики-страниц альтернатив](https://github.com/github-changelog-generator/Github-Changelog-Generator/wiki/Alternatives), которые я нашёл. Но ни один из них не удовлетворил моим требованиям.

Если вы знаете о других проектах, не стесняйтесь редактировать эту страницу вики!

**Проекты, использующие эту библиотеку**

Вот [вики-страница со списком проектов](https://github.com/github-changelog-generator/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).

Если вы использовали этот проект для создания журнала изменений своего проекта или знаете о других его использованиях, пожалуйста, сообщите мне! Ничто не делает меня счастливее, чем видеть, как кто-то берёт мою работу и сходит с ума от неё.

Если вы используете `github_changelog_generator` для создания журнала изменений вашего проекта или знаете другие проекты, использующие его, пожалуйста, [добавьте его в этот список](https://github.com/github-changelog-generator/github-changelog-generator/wiki/Projects-using-Github-Changelog-Generator).

## Мне не хватает какой-то важной функции?

— **Нет ничего невозможного!**

— Откройте… **Проблема** (https://github.com/github-changelog-generator/Github-Changelog-Generator/issues/new) и давайте вместе сделаем генератор лучше!

- *Отчёты об ошибках, запросы функций, патчи и пожелания всегда приветствуются.* :heavy_exclamation_mark:

## FAQ

- ***Я уже использую GitHub Releases. Зачем мне это нужно?***

GitHub Releases — это очень хорошая вещь. И поддерживать его — очень хорошая практика. (Пока им пользуется не так много людей!) :congratulations:

*Кстати, я хотел бы поддержать GitHub Releases в [следующих выпусках](https://github.com/github-changelog-generator/github-changelog-generator/issues/56);)*

Я не пытаюсь сравнивать качество рукописных и автоматически сгенерированных журналов. Тем не менее...

Автоматически сгенерированный журнал изменений действительно помогает, даже если вы вручную заполняете примечания к выпуску!

- ***Моя версия Ruby очень старая, могу ли я использовать её?***

Если ваш Ruby старый, вы не хотите обновляться и хотите контролировать, какие библиотеки используете, вы можете использовать Bundler.

В Gemfile, возможно, в не развёрнутой группе :development, добавьте этот
гем:

```ruby
group :development do
  gem 'github_changelog_generator', require: false
end

gem 'rack', '~> 1.6'