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

chore(discovery): ensure consistent names for discovery options in CRD #828

Merged
merged 1 commit into from
May 28, 2024

Conversation

tthvo
Copy link
Member

@tthvo tthvo commented May 22, 2024

Welcome to Cryostat! 👋

Before contributing, make sure you have:

  • Read the contributing guidelines
  • Linked a relevant issue which this PR resolves
  • Linked any other relevant issues, PR's, or documentation, if any
  • Resolved all conflicts, if any
  • Rebased your branch PR on top of the latest upstream main branch
  • Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
  • Signed all commits: git commit -S -m "YOUR_COMMIT_MESSAGE"

Related to #715

Description of the change:

  • Correct documentations for discovery fields. The field doc said the below previously though it should be the opposite.

    // When true, the Cryostat application will use the default port name jfr-jmx to look for JMX connectable targets.
    DisableBuiltInPortNames bool json:"disableBuiltInPortNames,omitempty"

  • Updated field names to be consistent. @ebaron Is it OK to update v1beta2 as such? Otherwise, I can just update the docs only.

Motivation for the change:

Documentation might be confusing as they state the opposite of what the fields should do.

@tthvo tthvo added chore Refactor, rename, cleanup, etc. safe-to-test labels May 22, 2024
@tthvo tthvo requested a review from a team May 22, 2024 04:43
@tthvo
Copy link
Member Author

tthvo commented May 22, 2024

/build_test

Copy link

/build_test completed successfully ✅.
View Actions Run.

@tthvo tthvo force-pushed the discovery-options branch from ab2146c to 37a065f Compare May 22, 2024 04:59
@tthvo
Copy link
Member Author

tthvo commented May 22, 2024

/build_test

Copy link

/build_test completed successfully ✅.
View Actions Run.

@tthvo tthvo force-pushed the discovery-options branch from 37a065f to b00ef09 Compare May 22, 2024 05:21
@tthvo
Copy link
Member Author

tthvo commented May 22, 2024

/build_test

Copy link

/build_test completed successfully ✅.
View Actions Run.

Copy link
Contributor

@aali309 aali309 left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Copy link
Member

@ebaron ebaron 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 that should be fine. I like the consistency as well. Just need another make bundle I think.

Signed-off-by: Thuan Vo <thuan.votann@gmail.com>
@tthvo tthvo force-pushed the discovery-options branch from b00ef09 to d57b572 Compare May 28, 2024 20:14
@tthvo
Copy link
Member Author

tthvo commented May 28, 2024

Sounds good! Updated now :D

@ebaron ebaron merged commit 7918cf9 into cryostatio:cryostat3 May 28, 2024
5 checks passed
@tthvo tthvo deleted the discovery-options branch May 28, 2024 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Refactor, rename, cleanup, etc. safe-to-test
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants