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.

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

Fix 404 in CRD generated documentation. #1621

Merged
merged 1 commit into from
Jun 10, 2020

Conversation

markmandel
Copy link
Member

What type of PR is this?
Fixes blocking 404 in CI

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug

/kind cleanup

/kind documentation
/kind feature
/kind hotfix

What this PR does / Why we need it:

  • Updated gen-crd-api-reference-docs
  • Added our own config to point to the version of K8s we want.
  • Manually updated the older CRD ref to point to 1.15, since it doesn't
    get updated automatically.
  • Added the ability to the htmltest config to disable external testing,
    for easier local dev testing.

Which issue(s) this PR fixes:

Closes #1617

Special notes for your reviewer:

None.

@markmandel markmandel added kind/documentation Documentation for Agones kind/cleanup Refactoring code, fixing up documentation, etc area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. labels Jun 10, 2020
@markmandel markmandel requested a review from aLekSer June 10, 2020 20:53
@markmandel markmandel force-pushed the cleanup/crd-gen branch 2 times, most recently from 3325758 to 71cb85c Compare June 10, 2020 21:00
- Updated gen-crd-api-reference-docs
- Added our own config to point to the version of K8s we want.
- Manually updated the older CRD ref to point to 1.15, since it doesn't
get updated automatically.
- Added the ability to the htmltest config to disable external testing,
  for easier local dev testing.

Closes googleforgames#1617
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: d67c9681-2dfc-429f-8b2b-1a5d8afec51f

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1621/head:pr_1621 && git checkout pr_1621
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.7.0-8f37755

Copy link
Collaborator

@aLekSer aLekSer left a comment

Choose a reason for hiding this comment

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

Thanks for the fast fix.

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aLekSer, markmandel

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

The pull request process is described here

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

@markmandel markmandel merged commit 58a0746 into googleforgames:master Jun 10, 2020
@markmandel markmandel deleted the cleanup/crd-gen branch June 10, 2020 21:53
@markmandel markmandel added this to the 1.7.0 milestone Jun 10, 2020
@aLekSer
Copy link
Collaborator

aLekSer commented Jun 10, 2020

One potential issue I come up with.Left a comment and will verify it tomorrow.

@@ -60,7 +62,7 @@ function sedeasy {
}

# do we have changes in generated API docs compared to previous version
diff $RESULT $OLD
diff $RESULT $OLD || true
Copy link
Collaborator

Choose a reason for hiding this comment

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

This might cause an error. Will it be always true?
I mean the next if on a second run should not update the doc.

Copy link
Member Author

Choose a reason for hiding this comment

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

oooh I see this now.

I had to put this in because set -e will exit this process as soon as the diff displays, so sometimes it will never move past this point, especially if ordering in the file changes.

Copy link
Member Author

Choose a reason for hiding this comment

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

Got a fix incoming shortly. Good spot.

markmandel added a commit to markmandel/agones that referenced this pull request Jun 10, 2020
I introduced a bug in googleforgames#1621 that means that the publish/expiry
replacement would never happen.

This fixes that issue, while also allowing us to maintain the `set -e`
within the bash script.
roberthbailey pushed a commit that referenced this pull request Jun 10, 2020
I introduced a bug in #1621 that means that the publish/expiry
replacement would never happen.

This fixes that issue, while also allowing us to maintain the `set -e`
within the bash script.
ilkercelikyilmaz pushed a commit to ilkercelikyilmaz/agones that referenced this pull request Oct 23, 2020
- Updated gen-crd-api-reference-docs
- Added our own config to point to the version of K8s we want.
- Manually updated the older CRD ref to point to 1.15, since it doesn't
get updated automatically.
- Added the ability to the htmltest config to disable external testing,
  for easier local dev testing.

Closes googleforgames#1617
ilkercelikyilmaz pushed a commit to ilkercelikyilmaz/agones that referenced this pull request Oct 23, 2020
I introduced a bug in googleforgames#1621 that means that the publish/expiry
replacement would never happen.

This fixes that issue, while also allowing us to maintain the `set -e`
within the bash script.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. cla: yes kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Documentation for Agones lgtm size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Site: fix obsolete links of Kubernetes API v1.13 in Autogenerated Agones CRD API reference
5 participants