[DOCU-575] Create a confluence plugin providing automated infos about latest versions of modules to produce links to nexus, etc. Created: 29/Jul/15  Updated: 05/Oct/16  Resolved: 07/Sep/15

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File module-info-bix-example.png    
Issue Links:
dependency
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Sprint: Sprint 5 (Basel), Sprint (Basel) 8
Story Points: 8

 Description   

In documentation we have tons of links to modules (jar files, etc.) to generated nexus site, etc.
Usually these links change after a new release - maintaining all the links is a pain, is easy forgotten and never really worked yet.

We already have a similar function - the javadoc macro. However this is a so called "user macro" and relies on a phyton script installed on a apache somewhere. User macro allow only very restricted logic.
In contrast, a "true" confluence plugin - developed with the atlassian sdk gives much more possibility - e.g. using java classes for components as macros.

Let's create a confluence plugin providing such functionality.



 Comments   
Comment by Christoph Meier [ 01/Aug/15 ]

For more details see:

GIT

Comment by Christoph Meier [ 23/Aug/15 ]

Done:

  • Use parent pom info.magnolia.maven.poms-internal:magnolia-parent-pom-internal to enable usage of magnolia continous building and releasing infrastructure
  • NexusClient (incl. authentication)
  • Artifact store to cache artifact infos to avoid to many nexus requests; using Atlassian cache api.
  • Macro to render a link (or just a label) of an Artifact (ArtifactResourceMacro).
  • Macro to display a "maven dependency section snippet" (ArtifactDependencySnippetMacro)
  • Macro to display a link to folder containing all the artifact of a version - or containing the folder of the versions (ArtifactResourcesFolderLinkMacro)
  • Macro to render a link list of all resources (known to nexus lucene index) of an artifact (ArtifactResourcesLinkListMacro).
  • Configuration ui for things like nexus connection properties (host, credentials, api base path, etc.).
  • docu How to use Confluence artifact-info-plugin

Open points / next steps

  • For artifact "latest" version make sure using only final versions (not using alpha. beta, milestones, etc.).
  • Improve docu or just link to README.mk
  • Additional component and macro to search and display the link to the "Nexus site" (example) of an artifact
  • Release version 1.0
Comment by Christoph Meier [ 03/Sep/15 ]

About nexus site search: Does nexus rest api provide help for effective-pom?
http://support.sonatype.com/requests/10161 (requires login)

Me:
I'm interested in the effective pom of a maven artifact preferably via nexus rest api.
I know there is a way to get it with maven help plugin with
...
By the way i "need" the effective pom because it contains a link to the maven generated site which is build during release process.

Answer:
This isn't possible, there is no REST API for this. You need to use the maven help plugin to get the effective pom, or use the class it uses. As I recall this i org.apache.maven.repository.internal.DefaultModelResolver.

Generated at Mon Feb 12 01:10:24 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.