Skip to content

Place dependency reports under docs/dependencies/ directory #585

@alexander-yevsyukov

Description

@alexander-yevsyukov

Our builds product two files that are use for rendering a list of dependencies of a module:

  • pom.xml — dependencies in Maven POM format.
  • dependencies.md — information about licenses used by a dependency.

The problem with the current approach is that pom.xml is a Maven build file.
Tools confuse this file with the Gradle files we really use for the builds.
For example, pom.xml is picked up by IDEA during the project import. This is not a bit issue because IDEA asks about what to use only once.

The bigger problem is AI agents that always scan pom.xml as the source of dependency information.
Sure, we can put pom.xml into the .aignore file. But it would not solve the issue with other non-agent tools.

In addition, we may want to extend the format of dependencies we currently have with more files or files of other format.
So, isolation of the content under the docs seems like a good step towards consolidating the project documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    /BuildBuild tasks/PublishBuild tasks related to publishingdependenciesAn issue on updating dependencies

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions