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.

Sign up for GitHub

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

Jump to bottom

hack/generate-docs.sh at release time and don't commit files. #478

Closed
wants to merge 1 commit into from
Closed

hack/generate-docs.sh at release time and don't commit files. #478

wants to merge 1 commit into from

Conversation

david-mcmahon
Copy link
Contributor

Fixes #470.

Going this route means we also should re-stub the release-1.9 doc files.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 7, 2017
enisoc
enisoc reviewed Dec 7, 2017
View reviewed changes
branchff
@@ -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)
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

@david-mcmahon david-mcmahon changed the title WIP: hack/generate-docs.sh at release time and don't commit files. hack/generate-docs.sh at release time and don't commit files. Dec 7, 2017
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 7, 2017
@david-mcmahon
Copy link
Contributor Author

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?

@david-mcmahon david-mcmahon added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Dec 8, 2017
@david-mcmahon
Copy link
Contributor Author

Today's branchff is dependent on this change. LGTY? @enisoc @dashpole

enisoc
enisoc reviewed Dec 12, 2017
View reviewed changes
anago
@@ -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.
Copy link
Member

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?

@david-mcmahon david-mcmahon mentioned this pull request Dec 12, 2017
Merged
@david-mcmahon david-mcmahon mentioned this pull request Jan 19, 2018
Merged
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 12, 2018
@david-mcmahon david-mcmahon removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 13, 2018
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 10, 2018
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten
/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 10, 2018
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

marpaia pushed a commit to marpaia/release that referenced this pull request Feb 21, 2019
@k8s-ci-robot
Merge pull request kubernetes#478 from pivotal-k8s/RelBranchMgmt-mail…
37cf071 
…inglist-setup

Branch Manager Handbook: Add note to request mailing list access
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@enisoc enisoc enisoc left review comments

Assignees

@enisoc enisoc

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@david-mcmahon @fejta-bot @enisoc @k8s-ci-robot