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: update the contributing guide for a successful cli debugging #1718

Conversation

shahramk64
Copy link
Contributor

Description

What this PR does / why we need it:

Following the guidelines in the Contributing file to debug the cli scenario does not result in a successful run. It seems that it assumes that a default config file exists in a specific path, which is not correct. A config file should be created for the cli scenario and it should be provided as an argument in the sample launch.json.

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

Type of change

  • 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 was tested by updating launch.json with the proposed sample json blob, and downloading notation.crt and making config_cli.json point to the downloaded file as described in the updated guide. After that, debugging with vscode results in a successful verification report.

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

Copy link

codecov bot commented Aug 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

see 10 files with indirect coverage changes

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 previously approved these changes Aug 19, 2024
@shahramk64 shahramk64 changed the title update the contributing guide for a successful cli debugging doc: update the contributing guide for a successful cli debugging Aug 20, 2024
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
Copy link
Collaborator

Please start with docs instead of doc in the ttile.

@shahramk64 shahramk64 changed the title doc: update the contributing guide for a successful cli debugging docs: update the contributing guide for a successful cli debugging Aug 21, 2024
@akashsinghal akashsinghal enabled auto-merge (squash) August 21, 2024 17:09
@akashsinghal akashsinghal merged commit 796c8c3 into ratify-project:dev Aug 21, 2024
19 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.

Contributing guidelines for command line debugging is not accurate.
4 participants