Skip to main content

Метаданные пакета Java для обновлений Dependabot

Добавьте метаданные в ваш файл pom.xml, чтобы предоставить полезные ссылки и контекст в Dependabot pull request-запросах на обновления Java пакетов.

Dependabot использует поля url, scm и issueManagement в файлах pom.xml для создания пулл-заявок на обновления Java зависимостей. Когда вы включаете эти метаданные, pull requests будут содержать ссылки на заметки релизов и трекеры проблем, что помогает пользователям с уверенностью обновлять пакеты.

Метаданные, которые Dependabot нуждаются в pom.xml файлах

Dependabot использует URL-адреса проекта, систему управления исходным кодом и систему управления вопросами для создания сводки для запросов на вытягивание обновлений.

  • : Главная страница проекта. См. дополнительную информацию о проекте в справочнике POM
  • : URL системы управления исходным кодом, используемой проектом. См. SCM в справочнике POM
  • : URL системы управления проблемами, используемой проектом. См. раздел «Управление проблемами » в справочнике POM

Пример проекта, размещенного на GitHub

<project>
  <url>https://github.com/OWNER/REPOSITORY</url>
  <scm>
    <url>https://github.com/OWNER/REPOSITORY</url>
  </scm>
  <issueManagement>
    <url>https://github.com/OWNER/REPOSITORY/issues</url>
  </issueManagement>
</project>

Влияние пропуска метаданных проекта из файлов pom.xml

Если вы забыли указать URL, которые проверяет Dependabot, то pull requests на обновление Java пакетов всё равно создаются. Однако сведения, доступные пользователям в сводке запроса на вытягивание, будут ограничены.

  • Репозиторий проектов или URL-адрес управления исходным кодом не определен: ссылки на заметки о выпуске в Dependabot запросы на вытягивание
  • Url-адрес управления проблемами не определен: нет ссылки на страницу проблем с отчетами.

Добавление этих сведений помогает Dependabot предоставлять более точные обновления для проекта, а также полезные ссылки на заметки о выпуске и средства отслеживания проблем.

Дополнительные материалы

  • Подключаемый модуль Maven SCM