Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish docs to spring.io #3333

Closed
wants to merge 2 commits into from

Conversation

pderop
Copy link
Member

@pderop pderop commented Jul 3, 2024

This is a new attempt to publish javadoc and reference docs to docs.spring.io/projecrtreactor/reactor-netty/

in previous abandonned PR #3328 , the PR was based on publishing an additional docs.zip with special properties, but this introduced important drawbacks:

  • an additional apidocs-zip classifier was added, meaning a new artifact to be pushed to artifactory & central
  • the docs publications were delayed (because autorepo scripts are based on cron jobs)
  • same for symlink generation, the autoln scripts are based on cron jobs)

in this PR, a new approach similar to spring-security deployDocs task is used: docs are now published instantly using some ssh commands (and autoln scripts are also executed using ssh).

So, no more delays, instant publication, and no more additional special docs zip published.

please notice the following:

  • a new docs/build.gradle has been added, but it must be run with a JDK compatible with JAVA 11, because the PR uses org.hidetake.ssh gradle plugin which requires java 11 +
  • because setup.gradle has been updated, I got trouble with spotless which could not parse the license headers from setup.gradle. After some researches, it turns out that I had to update the regex in build.gradle for the spotless task, and I did that same that has been done in the Add GraalVM smoke tests #2899 , in build.gradle.

on each push, the following docs will be updated here:

https://docs.spring.io/projectreactor/reactor-netty/docs/VERSION/api/ (javadoc)
https://docs.spring.io/projectreactor/reactor-netty/docs/VERSION/reference/html/ (reference doc)
https://docs.spring.io/projectreactor/reactor-netty/docs/VERSION/reference/pdf/ (pdf reference doc)
https://docs.spring.io/projectreactor/reactor-netty/docs/current -> (the latest stable docs)
https://docs.spring.io/projectreactor/reactor-netty/docs/current-SNAPSHOT -> (the most recent snapshot docs)
https://docs.spring.io/projectreactor/reactor-netty/docs/<major>.<minor>.x -> (the most recently released version starting with <major>.<minor>)
https://docs.spring.io/projectreactor/reactor-netty/docs/<major>.<minor>.x-SNAPSHOT -> (the most recent snapshot docs starting with <major>.<minor>)

you can check existing docs which have been manually uploaded in https://docs.spring.io/projectreactor/reactor-netty/docs/

@pderop pderop added the type/documentation A documentation update label Jul 3, 2024
@pderop pderop added this to the 1.0.47 milestone Jul 3, 2024
@pderop pderop self-assigned this Jul 3, 2024
@pderop
Copy link
Member Author

pderop commented Jul 3, 2024

mmm, let me fix some spotless checks before reviewing ... will do this in a few moment ...

@pderop pderop requested a review from a team July 3, 2024 14:10
@pderop
Copy link
Member Author

pderop commented Jul 3, 2024

@violetagg , it should be ok to review now; did my best to test this PR using a simulated environment ...
let me know.

@violetagg violetagg modified the milestones: 1.0.47, 1.0.48 Jul 8, 2024
@violetagg
Copy link
Member

Let's make a PR against 1.1.x branch instead of 1.0.x branch.
Can we find a way to not switch back and forth the java version?

@pderop
Copy link
Member Author

pderop commented Jul 10, 2024

Can we find a way to not switch back and forth the java version?

I'm precisely working on this topic currently.

@pderop pderop added the status/declined We feel we shouldn't currently apply this change/suggestion label Jul 10, 2024
@pderop
Copy link
Member Author

pderop commented Jul 10, 2024

I'm closing this PR, and will recreate a new one for 1.1.x (and will update this closed one to say it's superseded by the other one).

@pderop pderop closed this Jul 10, 2024
@pderop pderop removed this from the 1.0.48 milestone Jul 10, 2024
@violetagg violetagg removed the type/documentation A documentation update label Jul 10, 2024
@pderop
Copy link
Member Author

pderop commented Jul 10, 2024

This is superseded by #3345

@violetagg violetagg added the status/superseded An issue that has been superseded by another label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/declined We feel we shouldn't currently apply this change/suggestion status/superseded An issue that has been superseded by another
2 participants