Skip to content

adding conjur description#4578

Merged
Skarlso merged 7 commits intoexternal-secrets:mainfrom
aakashagg:main
Mar 23, 2025
Merged

adding conjur description#4578
Skarlso merged 7 commits intoexternal-secrets:mainfrom
aakashagg:main

Conversation

@aakashagg
Copy link
Copy Markdown
Contributor

@aakashagg aakashagg commented Mar 22, 2025 •
edited
Loading

Problem Statement

Improve Conjur authentication field descriptions

Related Issue

#4542

Proposed Changes

Improves documentation

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

@aakashagg aakashagg requested a review from a team as a code owner March 22, 2025 17:25
@aakashagg aakashagg requested a review from moolen March 22, 2025 17:25
@aakashagg
adding conjur description
1d858b1 
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>
@aakashagg aakashagg mentioned this pull request Mar 22, 2025
Closed
@gusfcarvalho
Copy link
Copy Markdown
Member

gusfcarvalho commented Mar 22, 2025

Hi @aakashagg . This need to be done in our Golang Struct models, otherwise this change is overriden by our doc/crd generation tooling.

@gusfcarvalho
Copy link
Copy Markdown
Member

gusfcarvalho commented Mar 22, 2025

you'll see make reviewable fails because this was not the proper way to add these comments :)

@aakashagg aakashagg force-pushed the main branch 2 times, most recently from 7e651d1 to 41f8344 Compare March 23, 2025 08:39
aakashagg and others added 2 commits March 23, 2025 14:10
@aakashagg
adding into Golang Struct models
3484ce2 
Your commit message

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>
@thecosmicfrog @aakashagg
Add webhook.create: false warning comment (external-secrets#4579)
8a6e07b 
* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

Revert "Add `webhook.create: false` warning comment (external-secrets#4579)"

This reverts commit 41f8344.
@aakashagg
Copy link
Copy Markdown
Contributor Author

aakashagg commented Mar 23, 2025

Hey @gusfcarvalho Thanks for correcting my mistake. I totally forgot that generally controller-gen takes care of the description when we give comments to the var in Golang Struct models.
I have updated the pr, please have a look :)

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Mar 23, 2025

@aakashagg Hello. :) You ned to run make check-diff so it generates the API doc correctly once you updated the right descriptions. And please also run make helm.test.update to update the helm CRD tests. :) Thanks!

@aakashagg
Copy link
Copy Markdown
Contributor Author

aakashagg commented Mar 23, 2025

Hi @Skarlso :), I have ran both the command and verified everything using make reviewable. In my local everything passes.
Thanks for helping. Let me know if we need any more changes

@Skarlso Skarlso merged commit 2e976ed into external-secrets:main Mar 23, 2025
1 of 2 checks passed
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Mar 23, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ivankatliarchuk added a commit to gofogo/external-secrets-fork that referenced this pull request Mar 25, 2025
@ivankatliarchuk
Merge branch 'main' into feat-aws-tags-1821
a289b42 
* main:
  update dependencies (external-secrets#4589)
  chore(deps): bump fossas/fossa-action from 1.5.0 to 1.6.0 (external-secrets#4586)
  chore(deps): bump mkdocs-material from 9.6.8 to 9.6.9 in /hack/api-docs (external-secrets#4588)
  chore(deps): bump platformdirs from 4.3.6 to 4.3.7 in /hack/api-docs (external-secrets#4587)
  chore(deps): bump github/codeql-action from 3.28.11 to 3.28.12 (external-secrets#4585)
  chore(deps): bump actions/setup-go from 5.3.0 to 5.4.0 (external-secrets#4584)
  chore(deps): bump golangci/golangci-lint-action from 6.5.1 to 6.5.2 (external-secrets#4583)
  chore(deps): bump actions/cache from 4.2.2 to 4.2.3 (external-secrets#4582)
  chore(deps): bump ubi8/ubi from `5993454` to `8bd1b63` (external-secrets#4581)
  Lookup cluster identity from instance metadata (external-secrets#4575)
  adding conjur description (external-secrets#4578)
  fix: bump jwt for cve fix (external-secrets#4580)
  Add `webhook.create: false` warning comment (external-secrets#4579)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Skarlso Skarlso Skarlso approved these changes

@moolen moolen Awaiting requested review from moolen moolen was automatically assigned from external-secrets/maintainers

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aakashagg @gusfcarvalho @Skarlso @thecosmicfrog