[GitHub] [incubator-pekko] pjfanning commented on pull request #456: setup CI job to publish 1.0 docs

["pjfanning (via GitHub)" <gi...@apache.org>]

pjfanning commented on PR #456:
URL: https://github.com/apache/incubator-pekko/pull/456#issuecomment-1614454712

   > > Once we branch for 1.0, why we would we have any doc changes that should not be visible to users? 1.0 branch is meant to be stable - no breaking changes in it.
   > 
   > Lets assume we have a branch `1.0.x` and someone creates a PR against `1.0.x` for a new feature which requires additional documentation. The feature gets merged into `1.0.x` but its not released yet (and realistically speaking its not uncommon to have unreleased features in branches for many months). If doc publishing is based off branches then we would publish docs for a feature that isn't even released yet, confusing people.
   > 
   > Branches are also mutable and change over time which would make any kind of doc publishing github actions job brittle, unlike tags which we deliberately designed to be as much as possible to be immutable.
   > 
   > > We currently have a code freeze in main branch. No changes should go into main in next few days that will affect the docs in a negative way and if it does, it will need to be fixed.
   > 
   > Yes, and what this encourages is for people to check the docs properly when a release is being made. Its slightly unfortunate that [apache/incubator-pekko-sbt-paradox#58](https://github.com/apache/incubator-pekko-sbt-paradox/pull/58) didn't land before the code freeze but I am happy to make an exception for that (not sure how official this would be though).
   
   We can adjust this job when we start making merges to the 1.0 branch that include doc changes that are breaking.
   
   When we discuss the branching strategy on the mailing list, I will be arguing against adding features in a patch release.


-- 
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: notifications-unsubscribe@pekko.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org