Skip to content

Add a macro to document a declared dependency #34

@philwebb

Description

@philwebb

We often need to guide users on how they can declare a dependency that they might need to consume. Often this involves both Maven and Gradle configuration and sometimes extra repository definitions. Some examples:

It would be helpful if we could simplify this markup using a macro.

Initial brainstorming on syntax could be something like dependency::<groupid>:<artifactid>[:version][]. With additional options to influence the format and options. E.g.:

dependency::org.springframework:spring-core:123[]
dependency::org.springframework:spring-core[]
dependency::org.springframework:spring-core[format=gradle]
dependency::org.springframework:spring-core[format=maven]
dependency::org.springframework.security:spring-security-saml2-service-provider[repo=https://build.shibboleth.net/maven/releases/]

Ideally the repositories section would make use of code folding.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions