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

add doc.go to each generated mainfest dir #1814

Merged
merged 7 commits into from Mar 16, 2024

Conversation

deads2k
Copy link
Contributor

@deads2k deads2k commented Mar 15, 2024

fixes problem for @p0lyn0mial

Copy link
Contributor

openshift-ci bot commented Mar 15, 2024

Hello @deads2k! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@deads2k deads2k added lgtm Indicates that a PR is ready to be merged. acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. labels Mar 15, 2024
@deads2k
Copy link
Contributor Author

deads2k commented Mar 15, 2024

transitive lgtm from #1814

@openshift-ci openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 15, 2024
Copy link
Contributor

openshift-ci bot commented Mar 15, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deads2k

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 15, 2024
@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD 094bb9e and 2 for PR HEAD 3f3ee66 in total

@deads2k
Copy link
Contributor Author

deads2k commented Mar 15, 2024

/retest

Copy link
Contributor

openshift-ci bot commented Mar 16, 2024

@deads2k: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-azure 3f3ee66 link false /test e2e-azure

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@openshift-merge-bot openshift-merge-bot bot merged commit 8ebde95 into openshift:master Mar 16, 2024
16 of 17 checks passed
@openshift-bot
Copy link

[ART PR BUILD NOTIFIER]

This PR has been included in build ose-cluster-config-api-container-v4.16.0-202403180813.p0.g8ebde95.assembly.stream.el9 for distgit ose-cluster-config-api.
All builds following this will include this PR.

wking added a commit to wking/cluster-version-operator that referenced this pull request Apr 30, 2024
Catching up with the YAML getting shifted into a subdirectory [1].  I
followed the new docs from [2] to create pkg/dependencymagnet, and
then:

  $ go get -u github.com/openshift/api@master
  $ go mod tidy
  $ go mod vendor
  $ sed -i 's|config/v1/0000_00_cluster-version-operator|config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator|g' $(git grep -l 0000_00_cluster-version-operator)
  $ git add -A Dockerfile* hack/test-prerequisites.go pkg/dependencymagnet go.* vendor

all using:

  $ go version
  go version go1.22.2 linux/amd64

[1]: openshift/api#1814
[2]: openshift/api@06baaa4#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R211
wking added a commit to wking/cluster-version-operator that referenced this pull request Apr 30, 2024
Catching up with the YAML getting shifted into a subdirectory [1].  I
followed the new docs from [2] to create pkg/dependencymagnet, and
then:

  $ go get -u github.com/openshift/api@master
  $ go mod tidy
  $ go mod vendor
  $ sed -i 's|config/v1/0000_00_cluster-version-operator|config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator|g' $(git grep -l 0000_00_cluster-version-operator)
  $ git add -A Dockerfile* hack/test-prerequisites.go pkg/dependencymagnet go.* vendor

all using:

  $ go version
  go version go1.22.2 linux/amd64

[1]: openshift/api#1814
[2]: openshift/api@06baaa4#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R211
wking added a commit to wking/cluster-version-operator that referenced this pull request Apr 30, 2024
Catching up with the YAML getting shifted into a subdirectory [1].  I
followed the new docs from [2] to create pkg/dependencymagnet, and
then:

  $ go get -u github.com/openshift/api@master
  $ go mod tidy
  $ go mod vendor
  $ sed -i 's|config/v1/0000_00_cluster-version-operator|config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator|g' $(git grep -l 0000_00_cluster-version-operator)
  $ git add -A Dockerfile* hack/test-prerequisites.go pkg/dependencymagnet go.* vendor

all using:

  $ go version
  go version go1.22.2 linux/amd64

[1]: openshift/api#1814
[2]: openshift/api@06baaa4#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R211
wking added a commit to wking/cluster-version-operator that referenced this pull request Apr 30, 2024
Catching up with the YAML getting shifted into a subdirectory [1].  I
followed the new docs from [2] to create pkg/dependencymagnet, and
then:

  $ emacs pkg/featuregates/featuregates.go  # configv1.FeatureGateUpgradeStatus -> features.FeatureGateUpgradeStatus
  $ go get github.com/openshift/api@master github.com/openshift/library-go@master
  $ go mod tidy
  $ go mod vendor
  $ sed -i 's|config/v1/0000_00_cluster-version-operator|config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator|g' $(git grep -l 0000_00_cluster-version-operator)
  $ git add -A Dockerfile* hack/test-prerequisites.go pkg/dependencymagnet go.* vendor

all using:

  $ go version
  go version go1.22.2 linux/amd64

A few points on the invocation:

* I usually use 'go get -u ...', e.g. a98232f (vendor: Bump
  openshift/api to pick up signatureStores, 2023-12-04, openshift#994), but in
  this case, that would pull in k8s.io/api@v0.30.0, and we want to
  stick with 0.29 until our release-4.16 branch stops following this
  development branch.

* I'm explicitly bumping library-go, because if I don't, builds on [3]:

    Building github.com/openshift/cluster-version-operator (v1.0.0-1203-g258de3f7-dirty)
    # github.com/openshift/library-go/pkg/manifest
    vendor/github.com/openshift/library-go/pkg/manifest/manifest.go:32:35: undefined: configv1.FeatureSets
    # github.com/openshift/cluster-version-operator/pkg/featuregates
    pkg/featuregates/featuregates.go:92:32: undefined: configv1.FeatureGateUpgradeStatus
    pkg/featuregates/featuregates.go:97:33: undefined: configv1.FeatureGateUpgradeStatus

  If I had been able to use -u, library-go would have automatically
  floated to the tip commit anyway.  But either way, I still needed to
  make manual changes to keep up with [4] moving to the new
  openshift/api/features package.

[1]: openshift/api#1814
[2]: openshift/api@06baaa4#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R211
[3]: https://prow.ci.openshift.org/view/gs/test-platform-results/pr-logs/pull/openshift_cluster-version-operator/1045/pull-ci-openshift-cluster-version-operator-master-images/1785396933666279424#1:build-log.txt%3A74-79
[4]: openshift/api#1821
wking added a commit to wking/cluster-version-operator that referenced this pull request Apr 30, 2024
Catching up with the YAML getting shifted into a subdirectory [1].  I
followed the new docs from [2] to create pkg/dependencymagnet, and
then:

  $ emacs pkg/featuregates/featuregates.go pkg/featuregates/featurechangestopper_test.go # configv1.FeatureGateUpgradeStatus -> features.FeatureGateUpgradeStatus
  $ go get github.com/openshift/api@master github.com/openshift/library-go@master
  $ go mod tidy
  $ go mod vendor
  $ sed -i 's|config/v1/0000_00_cluster-version-operator|config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator|g' $(git grep -l 0000_00_cluster-version-operator)
  $ git add -A Dockerfile* hack/test-prerequisites.go pkg/dependencymagnet go.* vendor

all using:

  $ go version
  go version go1.22.2 linux/amd64

A few points on the invocation:

* I usually use 'go get -u ...', e.g. a98232f (vendor: Bump
  openshift/api to pick up signatureStores, 2023-12-04, openshift#994), but in
  this case, that would pull in k8s.io/api@v0.30.0, and we want to
  stick with 0.29 until our release-4.16 branch stops following this
  development branch.

* I'm explicitly bumping library-go, because if I don't, builds on [3]:

    Building github.com/openshift/cluster-version-operator (v1.0.0-1203-g258de3f7-dirty)
    # github.com/openshift/library-go/pkg/manifest
    vendor/github.com/openshift/library-go/pkg/manifest/manifest.go:32:35: undefined: configv1.FeatureSets
    # github.com/openshift/cluster-version-operator/pkg/featuregates
    pkg/featuregates/featuregates.go:92:32: undefined: configv1.FeatureGateUpgradeStatus
    pkg/featuregates/featuregates.go:97:33: undefined: configv1.FeatureGateUpgradeStatus

  If I had been able to use -u, library-go would have automatically
  floated to the tip commit anyway.  But either way, I still needed to
  make manual changes to keep up with [4] moving to the new
  openshift/api/features package.

[1]: openshift/api#1814
[2]: openshift/api@06baaa4#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R211
[3]: https://prow.ci.openshift.org/view/gs/test-platform-results/pr-logs/pull/openshift_cluster-version-operator/1045/pull-ci-openshift-cluster-version-operator-master-images/1785396933666279424#1:build-log.txt%3A74-79
[4]: openshift/api#1821
wking added a commit to wking/cluster-version-operator that referenced this pull request Apr 30, 2024
Catching up with the YAML getting shifted into a subdirectory [1].  I
followed the new docs from [2] to create pkg/dependencymagnet, and
then:

  $ emacs pkg/featuregates/featuregates.go pkg/featuregates/featurechangestopper_test.go # configv1.FeatureGateUpgradeStatus -> features.FeatureGateUpgradeStatus
  $ go get github.com/openshift/api@master github.com/openshift/library-go@master
  $ go mod tidy
  $ go mod vendor
  $ sed -i 's|config/v1/0000_00_cluster-version-operator|config/v1/zz_generated.crd-manifests/0000_00_cluster-version-operator|g' $(git grep -l 0000_00_cluster-version-operator)
  $ git add -A Dockerfile* hack/test-prerequisites.go pkg/dependencymagnet go.* vendor

all using:

  $ go version
  go version go1.22.2 linux/amd64

A few points on the invocation:

* I usually use 'go get -u ...', e.g. a98232f (vendor: Bump
  openshift/api to pick up signatureStores, 2023-12-04, openshift#994), but in
  this case, that would pull in k8s.io/api@v0.30.0, and we want to
  stick with 0.29 until our release-4.16 branch stops following this
  development branch.

* I'm explicitly bumping library-go, because if I don't, builds fail on [3]:

    Building github.com/openshift/cluster-version-operator (v1.0.0-1203-g258de3f7-dirty)
    # github.com/openshift/library-go/pkg/manifest
    vendor/github.com/openshift/library-go/pkg/manifest/manifest.go:32:35: undefined: configv1.FeatureSets
    # github.com/openshift/cluster-version-operator/pkg/featuregates
    pkg/featuregates/featuregates.go:92:32: undefined: configv1.FeatureGateUpgradeStatus
    pkg/featuregates/featuregates.go:97:33: undefined: configv1.FeatureGateUpgradeStatus

  If I had been able to use -u, library-go would have automatically
  floated to the tip commit anyway.  But either way, I still needed to
  make manual changes to keep up with [4] moving to the new
  openshift/api/features package.

[1]: openshift/api#1814
[2]: openshift/api@06baaa4#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R211
[3]: https://prow.ci.openshift.org/view/gs/test-platform-results/pr-logs/pull/openshift_cluster-version-operator/1045/pull-ci-openshift-cluster-version-operator-master-images/1785396933666279424#1:build-log.txt%3A74-79
[4]: openshift/api#1821
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants