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: add description for notation.enabled in the helm charts readme… #1778

Conversation

shahramk64
Copy link
Contributor

@shahramk64 shahramk64 commented Sep 4, 2024

Description

What this PR does / why we need it:

After adding enabled feature in the helm chart values for notation, we need to add a description for it in the readme file.

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):

This is a remaining work from issue #1451

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?

It's a minimal change in the documentation. Tested visually by checking the readme file in the helm charts.

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

@shahramk64 shahramk64 marked this pull request as ready for review September 4, 2024 00:45
Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

see 19 files with indirect coverage changes

@shahramk64 shahramk64 force-pushed the skalantari/add-description-for-notation-enabled-feature-in-helm-charts-readme branch from ba1f215 to 7b1bff2 Compare September 4, 2024 00:49
charts/ratify/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@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

@binbin-li binbin-li enabled auto-merge (squash) September 4, 2024 03:53
@binbin-li binbin-li merged commit f548082 into ratify-project:dev Sep 4, 2024
17 checks passed
akashsinghal pushed a commit to akashsinghal/ratify that referenced this pull request Sep 13, 2024
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.

2 participants