You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Bukama (via GitHub)" <gi...@apache.org> on 2025/11/15 20:33:24 UTC

[I] Job to recreate page and publish it independent of release [maven-gh-actions-shared]

Bukama opened a new issue, #212:
URL: https://github.com/apache/maven-gh-actions-shared/issues/212

   ### New feature, improvement proposal
   
   As of now pages of components/plugins are only updated when a release happens. This is not useful as it's not possible to fix any kind of errors (regardless of typos/grammars,  broken links, or wrong content) and add new examples without either wait months/years for a release or release a component/plugin only for site update purposes


-- 
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: issues-unsubscribe@maven.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Job to recreate page and publish it independent of release [maven-gh-actions-shared]

Posted by "slawekjaranowski (via GitHub)" <gi...@apache.org>.
slawekjaranowski commented on issue #212:
URL: https://github.com/apache/maven-gh-actions-shared/issues/212#issuecomment-3622803031

   Maybe easier - maintain only version dependency documentation, or documentation generating automatically from code - like plugin documentation together with plugin/component and move the rest of documentation to maven-site - where can be ease changed and deployed after each commit.


-- 
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Job to recreate page and publish it independent of release [maven-gh-actions-shared]

Posted by "hboutemy (via GitHub)" <gi...@apache.org>.
hboutemy commented on issue #212:
URL: https://github.com/apache/maven-gh-actions-shared/issues/212#issuecomment-3550285894

   FTR reference doc on that topic for ASF Maven is https://maven.apache.org/developers/website/deploy-component-reference-documentation.html


-- 
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Job to recreate page and publish it independent of release [maven-gh-actions-shared]

Posted by "hboutemy (via GitHub)" <gi...@apache.org>.
hboutemy commented on issue #212:
URL: https://github.com/apache/maven-gh-actions-shared/issues/212#issuecomment-3550201139

   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
   2. publish plugin/component documentation for releases => found late (= what it described in this 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/) 
   
   how to have best of both worlds? good question: ideas welcome
   
   is it a question for GHA? perhaps one day, yes, but AFAIK it all starts with clarifying what doc updates can be published after the "current" release and what doc updates should wait for the next release
   => if we clarify by hand what we do at Git level (Git tags and commits in branches) and how we build, we'll see what automation can help


-- 
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Job to recreate page and publish it independent of release [maven-gh-actions-shared]

Posted by "Bukama (via GitHub)" <gi...@apache.org>.
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org