Release Notes
В одном предложении
Release Notes задумывался как приложение, превращающее изменения между двумя точками репозитория в примечания к выпуску для конечных пользователей; в просмотренном мной коде он выведен из эксплуатации и недоступен как размещённое приложение.
Чем он уникален
Сегодня сравнивать не с чем, поэтому эта глава — заметка о статусе, а не инструкция. Идея состояла в авторе заметок для конечных пользователей: функции, исправления ошибок и производительность — без имён классов и путей к файлам.
Когда использовать и когда нет
- Не ищите его на размещённых страницах: его страница, контроллер, воркер и задача были удалены из кодовой базы при последней чистке, а его место в списке плагинов помечено «Retired».
- Используйте вместо него:
- Repo Docs — для документации, созданной из репозитория.
- Code Graph — для структурной карты кода на одном коммите (имя файла содержит коммит, поэтому запуски на двух коммитах вы можете сравнить сами).
- Assembly Chat, команда Diff — для вопроса «что изменилось в публичном API этого пакета между версиями A и B», с отчётом и диаграммами.
Прежде чем начать
Готовить ничего не нужно. Если вы видели страницу Release Notes на скриншоте или по старой ссылке, это был интерфейс для выбора репозитория, ветки и диапазона (с последнего выпуска, между двумя тегами или коммитами либо ещё не выпущенные изменения) и выбора аудитории; в дереве продукта её больше нет (проверьте в работающем приложении, не осталась ли такая страница где-то онлайн).
Пошаговая инструкция
- Не рассчитывайте на размещённую страницу Release Notes.
- Для изменений API пакета .NET используйте Assembly Chat с командой Diff.
- Для документации текущего состояния репозитория используйте Repo Docs.
Параметры
| Параметр | Что делает | По умолчанию | Рекомендуется |
|---|---|---|---|
| (нет) | Приложение выведено из эксплуатации | – | См. альтернативы выше |
Что вы получите
Ничего от этого приложения. Родственный внутренний инструмент существует в планировщике компании — он создаёт примечания к выпуску из анализа влияния, но не выставлен как страница для читателей этой книги (проверьте, прежде чем кому-либо его обещать).
Качество и ограничения
Не применимо. Любой текст на сайте, заявляющий о поддержке Release Notes, считайте устаревшим, пока это не проверено.
Хорошо сочетается с
- Используйте вместо: Assembly Chat (Diff), Repo Docs.
- Рецепты: нет.
Типичные ошибки и их исправление
- Поиск кнопки Release Notes на главной странице ИИ → её там нет.
- Ожидание примечаний для конечных пользователей от Repo Docs → Repo Docs пишет техническую документацию, а не примечания к выпуску.
То же в других каналах
Не проверено. См. каналы.
Попробуйте
Сравните две версии пакета NuGet, которым вы пользуетесь, с помощью Assembly Chat (Diff) и перепишите его отчёт тремя простыми пунктами для ваших пользователей. Сегодня это самый близкий размещённый аналог.