MINOR: Add a command to make site-docs and Javadocs updates easier on version release #20478
+101
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clolov
changed the title
mimaison
reviewed
Sep 8, 2025
| # Find the site-docs archive | ||
| site_docs_archive = None | ||
| for file in os.listdir(artifacts_dir): | ||
| if file.endswith('-site-docs.tgz'): |
There was a problem hiding this comment.
This is a bit optimistic you can have -site-docs.tgz files for multiple versions. Can we guess the version like command_release_announcement_email() does?
| Assumes the Kafka website repo is on the same level as the Kafka repo and is named kafka-site. | ||
|
|
||
| Args: | ||
| dry_run (bool): If True, only prints what would happen without making changes |
There was a problem hiding this comment.
Since this is only touching local files, do we really need the dry_run argument?
| cwd=versioned_docs_path | ||
| ) | ||
|
|
||
| # Copy JavaDocs |
There was a problem hiding this comment.
Ideally this could run ./gradlew aggregatedJavadoc too
| 1. cd {kafka_site_path} | ||
| 2. git add {docs_version(project_version)} | ||
| 3. git commit -m "Add documentation for version {release_version}" | ||
| 4. git push origin master |
There was a problem hiding this comment.
Pushing to a branch instead of master is probably best
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Kafka website is hosted in a separate repository than the Kafka
code. The files versioned in the kafka-site repository are generated as
part of the version release process and then copied over. Today, this is
a manual process detailed in
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=34840886#ReleaseProcess-Websiteupdateprocess
This PR aims to simplify the manual steps by adding a sub-command to the
release.py script. The command uses the javadocs and *-site-docs.tgz in
the .release_work_dir and copies them over to the kafka-site repository.
There is a rudimentary dry-run sub-sub-command which can be used for
path-checking.
The addition to the script makes the assumption that the kafka-site
repository is on the same level as the kafka repository on a user's
machine. In the suggestion for subsequent commands it makes the further
assumption that the branch used in the kafka-site repository is
asf-site.
There are many things which we can improve about the overall script and
this addition in particular, but it is a start 😊.
I have tested this manually as part of the 4.0.1 release process and
cross-checked with the manual changes I did in
apache/kafka-site#718 and
apache/kafka-site#719