document release process automation#1010
Conversation
karmada-bot
added
the
kind/feature
karmada-bot
added
the
size/L
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request automates the document releasing and reference update processes by introducing a suite of bash and Node.js scripts, replacing previously manual steps. The documentation has been updated to reflect these changes. Feedback focuses on correcting file paths within the new scripts and ensuring the release script correctly utilizes the sidebar extraction tool to avoid environment-specific dependency issues.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request automates the Karmada website release process by introducing a suite of scripts for updating references, managing releases, and pruning old versions, while updating the developer documentation to reflect these new workflows. Feedback focuses on improving the robustness of the automation, specifically by broadening a regex to handle different quote styles and ensuring temporary file cleanup in extract-sidebar.js, as well as preventing duplicate version entries in versions.json during the release process.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request automates the Karmada website release and documentation update process by introducing a suite of scripts for generating reference docs, creating new releases, and pruning old versions. The developer documentation has been updated to reflect these automated workflows. Feedback focused on improving the robustness of the automation scripts, specifically by ensuring error messages are directed to standard error and using more reliable file-copying patterns to handle hidden files.
|
/cc @RainbowMango |
|
Hi @RainbowMango, all comments have been addressed, please take a look~ |
| File path: [website/infra/gen-resourcesdocs/config/current/toc.yaml](https://github.com/karmada-io/website/blob/main/infra/gen-resourcesdocs/config/current/toc.yaml). | ||
| Please refer to `website/infra/gen-resourcesdocs/README.md` for the file format and field descriptions. | ||
| Please refer to [swagger API docs](https://github.com/karmada-io/karmada/blob/master/api/openapi-spec/swagger.json) to get the latest Karmada API resources. | ||
| The Karmada API resource file only needs to be updated when Karmada introduces new API resources or API version changes. |
There was a problem hiding this comment.
- Add a link to the file
website/infra/gen-resourcesdocs/README.md. - It's not practical to grab API changes from the
swagger.json. In other words, it's hard for a contributor who does not know much about what we've done in the last release to figure out the API changes.
There was a problem hiding this comment.
Yeah, you're right. It's hard to make it clear how to get the latest Karmada API resources, so I chose to encapsulate it into a script dedicated to extracting toc.yaml from swagger.json.
karmada-bot
added
size/XL
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
karmada-bot
added
size/XXL
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
karmada-bot
added
the
approved
|
/hold |
karmada-bot
added
the
do-not-merge/hold
|
@zhzhuang-zju did you forget to check in the https://github.com/karmada-io/website/blob/main/infra/gen-resourcesdocs/config/current/toc.yaml file? |
3 participants
What type of PR is this?
/kind feature
What this PR does / why we need it:
Add automated scripts to complete document release and update the Documentation Releasing guide, so as to reduce workload when releasing new versions or synchronizing the Karmada repository.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: