Skip to content

Don't show removed API reference docs#744

Merged
jetstack-bot merged 2 commits intocert-manager:masterfrom
irbekrm:remove_alpha_beta-docs
Dec 3, 2021
Merged

Don't show removed API reference docs#744
jetstack-bot merged 2 commits intocert-manager:masterfrom
irbekrm:remove_alpha_beta-docs

Conversation

@irbekrm
Copy link
Contributor

@irbekrm irbekrm commented Nov 3, 2021

This PR depends on #745 which needs to be merged and cherry-picked into release-1.6 branch first as else this will fail because we still refer to alpha/beta API versions from the API reference doc in a few places .

This PR adds a workaround to ensure that API reference docs generated from cert-manager release-1.6 branch do not include the documentation for the removed alpha and beta APIs.
The 'next' docs that are generated from release-1.7 branch still refers to alpha and beta APIs, but this will not need a workaround as we are going to remove those packages in cert-manager 1.7

Note: as the deploy preview does not include API reference docs, this fix can be verified by running the website locally:

  1. checkout this branch
  2. run ./scripts/gendocs/generate
  3. run ./scripts/server
  4. go to http://localhost:1313/ and verify that the 'current' API reference docs do not include the alpha and beta API docs

Signed-off-by: irbekrm irbekrm@gmail.com

Signed-off-by: irbekrm <irbekrm@gmail.com>
@jetstack-bot jetstack-bot added the dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. label Nov 3, 2021
@netlify
Copy link

netlify bot commented Nov 3, 2021

✔️ Deploy Preview for cert-manager-website ready!

🔨 Explore the source changes: 231b646

🔍 Inspect the deploy log: https://app.netlify.com/sites/cert-manager-website/deploys/61821feb7690bb00070b3bba

😎 Browse the preview: https://deploy-preview-744--cert-manager-website.netlify.app

@jetstack-bot jetstack-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 3, 2021
Signed-off-by: irbekrm <irbekrm@gmail.com>
@irbekrm
Copy link
Contributor Author

irbekrm commented Nov 4, 2021

/retest

@irbekrm
Copy link
Contributor Author

irbekrm commented Nov 5, 2021

/cherry-pick release-1.6

@jetstack-bot
Copy link
Contributor

@irbekrm: once the present PR merges, I will cherry-pick it on top of release-1.6 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-1.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this makes sense,
but don't think we need to cherry-pick in to the release-1.6 branch.
The current release is 1.6 and the docs for this are in master branch (until we release 1.7)

And if I use the correct preview link (there are now two!), I can see that the legacy APIs are no longer shown 👍

/lgtm
/approve

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 3, 2021
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irbekrm, wallrj

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jetstack-bot jetstack-bot merged commit 73b4516 into cert-manager:master Dec 3, 2021
@jetstack-bot
Copy link
Contributor

@irbekrm: #744 failed to apply on top of branch "release-1.6":

Applying: Don't show removed API reference docs
Using index info to reconstruct a base tree...
M	scripts/gendocs/generate
Falling back to patching base and 3-way merge...
Auto-merging scripts/gendocs/generate
CONFLICT (content): Merge conflict in scripts/gendocs/generate
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Don't show removed API reference docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherry-pick release-1.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants