Skip to content

docs: add helm chart readme#1099

Merged
akashsinghal merged 3 commits intonotaryproject:mainfrom
akashsinghal:akashsinghal/addHelmDoc
Sep 28, 2023
Merged

docs: add helm chart readme#1099
akashsinghal merged 3 commits intonotaryproject:mainfrom
akashsinghal:akashsinghal/addHelmDoc

Conversation

@akashsinghal
Copy link
Copy Markdown
Collaborator

@akashsinghal akashsinghal commented Sep 26, 2023

Description

Adds a readme for helm chart values.
Inspiration from Gatekeeper's helm chart.

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #564

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

@codecov
Copy link
Copy Markdown

codecov bot commented Sep 26, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (af10ccc) 52.28% compared to head (f202287) 52.28%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1099   +/-   ##
=======================================
  Coverage   52.28%   52.28%           
=======================================
  Files         101      101           
  Lines        6291     6291           
=======================================
  Hits         3289     3289           
  Misses       2684     2684           
  Partials      318      318           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@akashsinghal akashsinghal self-assigned this Sep 26, 2023
@akashsinghal akashsinghal force-pushed the akashsinghal/addHelmDoc branch from 8165085 to b3a1dd2 Compare September 27, 2023 00:01
@akashsinghal akashsinghal force-pushed the akashsinghal/addHelmDoc branch from b3a1dd2 to 8eaf1b3 Compare September 27, 2023 00:03
@akashsinghal akashsinghal marked this pull request as ready for review September 27, 2023 00:04
@akashsinghal
Copy link
Copy Markdown
Collaborator Author

@binbin-li @susanshi appreciate a review on this whenever you have a chance. No rush on this.

Copy link
Copy Markdown
Contributor

@binbin-li binbin-li left a comment

Choose a reason for hiding this comment

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

Maybe it's quite a lot of work, wonder if we should pin to doc for each parameter or param group if we have doc on it.

Copy link
Copy Markdown
Contributor

@binbin-li binbin-li left a comment

Choose a reason for hiding this comment

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

lgtm. For the doc link, as we discussed in the community meeting, we can reconsider how to add it in the future.

@akashsinghal akashsinghal enabled auto-merge (squash) September 28, 2023 16:56
@akashsinghal akashsinghal merged commit 3ed18af into notaryproject:main Sep 28, 2023
bspaans pushed a commit to bspaans/ratify that referenced this pull request Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add readme for helm configuration

2 participants