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(gen): upgrades to crd-ref-doc generator to latest version #920

Merged
merged 2 commits into from
Mar 16, 2024

Conversation

zdtsw
Copy link
Member

@zdtsw zdtsw commented Mar 15, 2024

  • add "diff" in the failed GH action to help understand problem

Description

in https://github.com/elastic/crd-ref-docs/releases/tag/v0.0.11 it has the bug fix for a wrong rending content.
this is causing the current runs failing,

  • add debug to help know if it is a false error:

How Has This Been Tested?

from current incubation:
Screenshot from 2024-03-15 18-09-24
from my PR code:
Screenshot from 2024-03-15 18-09-32

failed GH action run with debug info:
want to revert "enum" part in the PR which indicates PR has change should be commited

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

- add "diff" in the failed GH action to help understand problem

Signed-off-by: Wen Zhou <wenzhou@redhat.com>
Signed-off-by: Zhou, Wen <eircchou19831101@gmail.com>
Copy link
Contributor

@AjayJagan AjayJagan left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@bartoszmajsak bartoszmajsak left a comment

Choose a reason for hiding this comment

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

Took me a while to understand how (first line of PR description):

add "diff" in the failed GH action to help understand problem

is actually fixing anything... but after looking at the changes I understand :)

I think the fix is more about fix(gen) than gh action though :) Maybe the title should be:

fix(gen): upgrades to crd-doc generator to latest version

Thanks! LGTM

Copy link

openshift-ci bot commented Mar 15, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AjayJagan, bartoszmajsak

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

@zdtsw zdtsw changed the title fix(gh): upgrade to latest version with has a bug fix fix(gh): upgrade to latest version with a bug fix Mar 16, 2024
@zdtsw zdtsw changed the title fix(gh): upgrade to latest version with a bug fix fix(gen): upgrades to crd-ref-doc generator to latest version Mar 16, 2024
@zdtsw zdtsw merged commit 301a09e into opendatahub-io:incubation Mar 16, 2024
7 of 8 checks passed
zdtsw added a commit to zdtsw-forking/rhods-operator that referenced this pull request Mar 25, 2024
…tahub-io#920)

fix(gen): upgrades to crd-ref-doc to latest version

- add "diff" in the failed GH action to help understand problem
- update: api doc

---------

Signed-off-by: Wen Zhou <wenzhou@redhat.com>
zdtsw added a commit to red-hat-data-services/rhods-operator that referenced this pull request Mar 25, 2024
* feat(gh-action): ensures generated files are up-to-date in PR (opendatahub-io#917)

* RHOAIENG-4433 Update readme/config files

* rework gh action based on comments

* feat(gh-action): ensures generated files are up-to-date in PR

* fix review comments

* reuse cmd

* fix(gen): upgrades to crd-ref-doc generator to latest version (opendatahub-io#920)

fix(gen): upgrades to crd-ref-doc to latest version

- add "diff" in the failed GH action to help understand problem
- update: api doc

---------

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

* fix: Enable annotations using golangci-lint(gh action) (opendatahub-io#919)

* fix: Enable annotations using golangci-lint(gh action)

* update versions

* fix(make): cleans linter cache on clean (opendatahub-io#922)

When juggling between branches golangci linter cache can have leftovers from the code that does not exist in the other branch.

This can lead to errors while running `make lint` as the linter tries to check cached sources first.

This change cleans the linter cache as part of the clean target to ensure consistency.

Here's an example of an invalid cache state leading to error:

```
WARN [runner] Can't process result by autogenerated_exclude processor: can't filter issue result.Issue{FromLinter:"ireturn", Text:"Entry returns interface (github.com/opendatahub-io/opendatahub-operator/v2/pkg/feature.DataProvider)", Severity:"", SourceLines:[]string(nil), Replacement:(*result.Replacement)(nil), Pkg:(*packages.Package)(0xc001343e00), LineRange:(*result.Range)(nil), Pos:token.Position{Filename:"/home/bartek/code/rhods/opendatahub-operator/incubation/pkg/feature/data_provider.go", Offset:1382, Line:45, Column:1}, HunkPos:0, ExpectNoLint:false, ExpectedNoLintLinter:""}: failed to get doc of file
```

* chore(Github): update issue template re-direct user for jira (opendatahub-io#838)

* chore(Github): update issue template re-direct user for jira

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

* Update .github/ISSUE_TEMPLATE/feature_request.md

Co-authored-by: Ajay Jaganathan <36824134+AjayJagan@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/bug_report.md

Co-authored-by: Ajay Jaganathan <36824134+AjayJagan@users.noreply.github.com>

---------

Signed-off-by: Wen Zhou <wenzhou@redhat.com>
Co-authored-by: Ajay Jaganathan <36824134+AjayJagan@users.noreply.github.com>

* chore: Small Makefile fixes (opendatahub-io#928)

* Go back to using `IMG ?=` rather than forcing the value with `IMG =`. This makes it easier to override the value of `IMG` for development, and it also aligns it to how `BUNDLE_IMG` is assigned.
* Add `prepare` as dependency of the `undeploy` target. This is just for convenience, although when looking at the other targets, `prepare` may simply be a missing dependency in `undeploy`.

Signed-off-by: Edgar Hernández <23639005+israel-hdez@users.noreply.github.com>

* fix(test): pin version not latest which just introduced to use go 1.22 (opendatahub-io#934)

* fix(test): pin version not latest which just introduced to use go 1.22

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

* update: code review

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

---------

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

---------

Signed-off-by: Wen Zhou <wenzhou@redhat.com>
Signed-off-by: Edgar Hernández <23639005+israel-hdez@users.noreply.github.com>
Co-authored-by: Ajay Jaganathan <36824134+AjayJagan@users.noreply.github.com>
Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
Co-authored-by: Edgar Hernández <ehernand@redhat.com>
@bartoszmajsak bartoszmajsak mentioned this pull request Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants