Bukama commented on issue #212:
URL: 
https://github.com/apache/maven-gh-actions-shared/issues/212#issuecomment-3622743026

   
   
   Sorry for the late repond, always saw your comments, but didn't answer.
   
   > there has always been a choice done between 2 approaches:
   > 
   > 1. publish plugin/component documentation as soon as possible, then for 
SNAPSHOTs => found "not useful" as not releases, so can show features that are 
not yet released
   > 2. publish plugin/component documentation for releases => found late (= 
what is described in this GH issue)
   > 
   > for now, approach 2 won at ASF Maven (and Plexus and Mojohaus), while for 
example approach 1 won at [CycloneDX Maven 
plugin](https://cyclonedx.github.io/cyclonedx-maven-plugin/): pick your poison
   
   I think there's a missing third one: "the documentation only release" (which 
I request here). I'll try to explain what I mean.
   
   For simplicty, imagine our project contains of two files: one java/source 
("S") and one documentation file "D". With every commit both S and D might 
change. At one point on the timeline both are published for the first time 
("release 1.0.0"). Dependending on the situation there might be a release-1.0.x 
branch for maintaining that version and a master for 1.1.x+. But that doesn't 
matter here, because both, master and the release branch accept changes in S 
**and** D. As of now we only have pipeline that can create and publish site 
during a release - in other words: on a code base where S **and** D might have 
changed, which leads to the two situations you described above.
   
   Maven site is not very special here, as there are just no ("visible" source 
commits or) versions changes, but only documentation commits. Site has version 
1.0 since ever. In practice this looks like only documentation is updated.
   
   
   What I think we need is a pipeline that can create and publish site and only 
site from any given branch at any time. This would allow to create a 
"documentation-fixes" branch for a certain release, which accepts (I guess not 
enforceable technically) **only* documentation commits, for example fixing 
grammar mistakes, adding examples etc. Then this branch can be used to update 
site, without having source code released. If the documentation commits then 
get ported to master/released-branches depends on the project's situation.
   
   I tried to visualize with a sketch.
   
   <img width="1843" height="595" alt="Image" 
src="https://github.com/user-attachments/assets/309cdd15-884d-4571-9972-a114fd467f2b";
 />
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to