-
Notifications
You must be signed in to change notification settings - Fork 499
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
hack/generate-docs.sh at release time and don't commit files. #478
hack/generate-docs.sh at release time and don't commit files. #478
Conversation
@@ -175,8 +175,7 @@ logrun -s git merge -X ours $MASTER_OBJECT | |||
# <snip> | |||
# Commit your changes in another terminal and then continue here by pressing enter. | |||
|
|||
USEFUL_UPDATES=(update-openapi-spec generate-docs | |||
update-federation-openapi-spec) | |||
USEFUL_UPDATES=(update-openapi-spec update-federation-openapi-spec) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also run update-generated-docs
now to ensure the stubs are all right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The branch will no longer ever be "polluted" with generated docs and further, when branchff has fast-forwarded it to master, that in and of itself will ensure the stubs are there. There's no need to run update-generated-docs.sh at this point. If master somehow gets trashed, verify-generated-docs.sh will catch it long before branchff is ever run.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should go in before today's branchff.
Surprised noone has noticed the stubs on the 1.8 releases. @devin-donnelly do you know if these are the same docs on k8s.io? I don't know the status of these docs, whether they are in sync with k8s.io or if they are even needed anymore? |
@@ -608,22 +608,19 @@ prepare_tree () { | |||
fi | |||
|
|||
# rev openapi-spec version files on branch for beta tags | |||
# and generate docs (not checked in) for official|rc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the latest step at which we could generate the docs? Will this cause git versions to appear as -dirty
?
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Stale issues rot after 30d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Rotten issues close after 30d of inactivity. Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
…inglist-setup Branch Manager Handbook: Add note to request mailing list access
Fixes #470.
Going this route means we also should re-stub the release-1.9 doc files.