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

docs: add notaryv2 upgrade doc #999

Merged
merged 4 commits into from
Aug 17, 2023
Merged

Conversation

binbin-li
Copy link
Collaborator

@binbin-li binbin-li commented Aug 15, 2023

Description

What this PR does / why we need it:

As we updated notaryv2 to notation across the project, we would need to add a section explaining how to help users update the config and constraint template.

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 #978

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

codecov bot commented Aug 15, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.94% ⚠️

Comparison is base (b600277) 59.11% compared to head (fd0b2a5) 58.17%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #999      +/-   ##
==========================================
- Coverage   59.11%   58.17%   -0.94%     
==========================================
  Files          73       91      +18     
  Lines        4432     5447    +1015     
==========================================
+ Hits         2620     3169     +549     
- Misses       1567     1964     +397     
- Partials      245      314      +69     

see 37 files with indirect coverage changes

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

@binbin-li binbin-li changed the title doc: add notaryv2 upgrade doc docs: add notaryv2 upgrade doc Aug 15, 2023
@akashsinghal
Copy link
Collaborator

Slightly unrelated but on our readme, there's one notary v2 reference that was missed. Could we just add that to this PR?

Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

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

LGTM. thanks!

@binbin-li binbin-li enabled auto-merge (squash) August 17, 2023 02:39
@binbin-li binbin-li merged commit fa91479 into ratify-project:main Aug 17, 2023
15 of 16 checks passed
junczhu pushed a commit to ZAFT-Armored-Keeper-of-Unity/ratify that referenced this pull request Aug 23, 2023
junczhu added a commit to ZAFT-Armored-Keeper-of-Unity/ratify that referenced this pull request Aug 23, 2023
fix: fix cert-rotator test (ratify-project#992)

chore: bump github.com/aws/aws-sdk-go-v2/config from 1.18.32 to 1.18.33 (ratify-project#988)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Akash Singhal <akashsinghal@microsoft.com>

feat: add graceful shutdown for http server (ratify-project#949)

fix: Updating akv cert provider to use getSecret (ratify-project#957)

Signed-off-by: Susan Shi <huish@microsoft.com>

chore: bump golangci/golangci-lint-action from 3.6.0 to 3.7.0 (ratify-project#997)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

chore: bump actions/setup-go from 4.0.1 to 4.1.0 (ratify-project#996)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

fix: adding experimental to dynamic plugin flag (ratify-project#980)

refactor: refactor error handling (ratify-project#956)

docs: add notaryv2 upgrade doc (ratify-project#999)

chore: update assign.yaml template

chore: update library templates

chore: update library templates2

chore: update library templates fix typo

chore: update library templates array
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 doc to explain how to work with notation renaming
3 participants