notation icon indicating copy to clipboard operation
notation copied to clipboard

Added cli doc generation and refactored examples

Open zr-msft opened this issue 2 years ago • 6 comments
trafficstars

…Examples field

Here is a launch.json for testing:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Generate Docs",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${fileDirname}",
            "env": 
                {
                    "GEN_CLI_DOCS": "true"
                },
        }
    ]
}

MD files are generated in notation-reference-doc but have been added to .gitignore to avoid adding them to the repo

If environment variable is absent, behavior should be normal.

zr-msft avatar May 25 '23 20:05 zr-msft

Codecov Report

Attention: Patch coverage is 77.24138% with 33 lines in your changes missing coverage. Please review.

Project coverage is 63.20%. Comparing base (b7e5a6f) to head (b4bd926). Report is 139 commits behind head on main.

Files with missing lines Patch % Lines
cmd/notation/generate_docs.go 25.00% 32 Missing and 1 partial :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #687      +/-   ##
==========================================
- Coverage   63.98%   63.20%   -0.78%     
==========================================
  Files          40       41       +1     
  Lines        2252     2294      +42     
==========================================
+ Hits         1441     1450       +9     
- Misses        689      721      +32     
- Partials      122      123       +1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar May 25 '23 20:05 codecov-commenter

@yizha1 moving to draft to avoid merging and adding risk to the next release

zr-msft avatar Jun 13 '23 21:06 zr-msft

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

github-actions[bot] avatar Mar 23 '24 01:03 github-actions[bot]

@yizha1 Besides the private preview comments, is this PR OK to merge?

rayoef avatar Apr 12 '24 21:04 rayoef

Hi @rayoef It seems this PR is no longer up-to-date. @FeynmanZhou Could you please advise on the next steps for this PR, since it is related to the CLI doc generation?

yizha1 avatar Apr 16 '24 03:04 yizha1

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

github-actions[bot] avatar Jun 01 '24 01:06 github-actions[bot]

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

github-actions[bot] avatar Jul 17 '24 01:07 github-actions[bot]

This PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

github-actions[bot] avatar Sep 01 '24 02:09 github-actions[bot]

Close this PR. @zr-msft is being honored in memoriam.

yizha1 avatar Sep 09 '24 14:09 yizha1