Ключевые факты
- Категория
- Development
- Типы входных данных
- textarea, select, checkbox
- Тип результата
- json
- Покрытие примерами
- 4
- API доступен
- Yes
Обзор
Извлекатель Журнала Изменений — это онлайн-инструмент для анализа и извлечения структурированных данных из журналов изменений и примечаний к выпуску. Он поддерживает популярные форматы, такие как Keep a Changelog, Conventional Commits и GitHub Releases, автоматически определяя формат и предоставляя результат в виде JSON с подробной статистикой.
Когда использовать
- •Когда необходимо быстро извлечь информацию о версиях из большого журнала изменений для документации.
- •При подготовке руководств по миграции или сравнении версий программного обеспечения.
- •Для анализа истории изменений проекта и категоризации обновлений по типам.
Как это работает
- •Вставьте содержимое журнала изменений в текстовое поле на странице.
- •Выберите формат журнала из списка или оставьте автоопределение.
- •Настройте параметры, например, включение полных описаний изменений.
- •Нажмите кнопку извлечения, чтобы получить структурированные данные в формате JSON.
Сценарии использования
Примеры
1. Извлечение данных из Keep a Changelog
Разработчик- Контекст
- Разработчик ведет проект с журналом изменений в формате Keep a Changelog и needs to generate API documentation.
- Проблема
- Нужно получить структурированный список всех версий и изменений для включения в документацию API.
- Как использовать
- Вставьте содержимое файла CHANGELOG.md в поле 'Содержимое Журнала Изменений' и выберите формат 'Keep a Changelog'.
- Результат
- Получен JSON с номерами версий, датами выпуска и категоризированными изменениями, готовый для использования в документации.
2. Анализ Conventional Commits
Менеджер проекта- Контекст
- Менеджер проекта анализирует историю Git коммитов для создания отчета о версиях.
- Проблема
- Нужно структурировать информацию из сообщений коммитов, чтобы понять, какие изменения были внесены в каждой версии.
- Как использовать
- Скопируйте лог коммитов (например, с помощью git log) и вставьте в текстовое поле, установив формат 'Conventional Commits'.
- Результат
- Извлечены данные о версиях с областями и типами изменений, что позволяет легко анализировать историю проекта.
3. Обработка GitHub Releases
DevOps инженер- Контекст
- DevOps инженер настраивает автоматическое создание примечаний к выпуску на основе существующих выпусков GitHub.
- Проблема
- Нужно извлечь структурированные данные из примечаний к выпуску для использования в шаблонах или системах уведомлений.
- Как использовать
- Перейдите в раздел Releases вашего репозитория на GitHub, скопируйте текст примечаний и вставьте в инструмент, выбрав 'GitHub Releases'.
- Результат
- Получены JSON данные с функциями, исправлениями и другими изменениями для каждого выпуска, упрощая процесс создания новых примечаний.
Проверить на примерах
textСвязанные хабы
FAQ
Какие форматы журналов изменений поддерживаются?
Инструмент поддерживает Keep a Changelog, Conventional Commits, GitHub Releases и автоматическое определение формата.
В каком виде предоставляется результат?
Результат выводится в структурированном формате JSON, содержащем номера версий, даты выпуска, категории изменений и описания.
Можно ли использовать инструмент для нестандартных журналов?
Автоопределение может работать с некоторыми вариациями, но для точности рекомендуется использовать поддерживаемые форматы.
Требуется ли регистрация или установка?
Нет, инструмент работает онлайн в браузере без необходимости регистрации или установки дополнительного ПО.
Как обрабатываются большие файлы?
Инструмент способен обрабатывать большие объемы текста, но время обработки может увеличиваться в зависимости от размера журнала.