-
Notifications
You must be signed in to change notification settings - Fork 90
fix: Support auto-generated CLI reference doc in the notation repo #1336
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
Open
majiayu000
wants to merge
1
commit into
notaryproject:main
Choose a base branch
from
majiayu000:fix-859-support-auto-generated-cli-ref-1230-1347
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Copyright The Notary Project Authors. | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| name: update-cli-docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'cmd/notation/**' | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| update-cli-docs: | ||
| name: Update CLI Documentation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | ||
|
|
||
| - name: Set up Go | ||
| uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0 | ||
| with: | ||
| go-version-file: 'go.mod' | ||
| check-latest: true | ||
|
|
||
| - name: Generate CLI documentation | ||
| run: make cli-docs | ||
|
|
||
| - name: Get commit metadata | ||
| id: commit-metadata | ||
| run: | | ||
| echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT | ||
| echo "date=$(git show -s --format=%ci HEAD)" >> $GITHUB_OUTPUT | ||
| echo "author=$(git show -s --format='%an' HEAD)" >> $GITHUB_OUTPUT | ||
| - name: Create pull request | ||
| uses: peter-evans/create-pull-request@5618a875e3f59ed17e5d3bf7a6fa0ee3ac66c3e3 # v7.1.0 | ||
| with: | ||
| commit-message: | | ||
| docs: auto-generate CLI reference documentation | ||
| Generated from commit ${{ steps.commit-metadata.outputs.sha }} | ||
| branch: auto-update-cli-docs | ||
| delete-branch: true | ||
| title: 'docs: auto-update CLI reference documentation' | ||
| body: | | ||
| ## Description | ||
| This PR updates the CLI reference documentation to reflect changes in the command-line interface. | ||
| ## Source Commit | ||
| - **SHA**: ${{ steps.commit-metadata.outputs.sha }} | ||
| - **Date**: ${{ steps.commit-metadata.outputs.date }} | ||
| - **Author**: ${{ steps.commit-metadata.outputs.author }} | ||
| --- | ||
| *This PR was automatically generated by the [update-cli-docs workflow](https://github.com/${{ github.repository }}/blob/main/.github/workflows/update-docs-cli.yml).* | ||
| labels: | | ||
| documentation | ||
| automated pr | ||
| draft: false | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,3 +22,4 @@ test/e2e/coverage.txt | |
| **/covcounters.* | ||
| **/covmeta.* | ||
| dist/ | ||
| docs/cli/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| //go:build gendoc | ||
|
|
||
| // Copyright The Notary Project Authors. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra/doc" | ||
| ) | ||
|
|
||
| func main() { | ||
| if len(os.Args) < 2 { | ||
| fmt.Fprintf(os.Stderr, "Usage: %s <output-dir>\n", os.Args[0]) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| outputDir := os.Args[1] | ||
|
|
||
| if err := os.MkdirAll(outputDir, 0755); err != nil { | ||
| fmt.Fprintf(os.Stderr, "Error creating output directory: %v\n", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| cmd := NewRootCommand() | ||
|
|
||
| if err := doc.GenMarkdownTree(cmd, outputDir); err != nil { | ||
| fmt.Fprintf(os.Stderr, "Error generating documentation: %v\n", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| fmt.Printf("Successfully generated CLI documentation in %s\n", outputDir) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // Copyright The Notary Project Authors. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/notaryproject/notation-go/dir" | ||
| "github.com/notaryproject/notation/v2/cmd/notation/blob" | ||
| "github.com/notaryproject/notation/v2/cmd/notation/cert" | ||
| "github.com/notaryproject/notation/v2/cmd/notation/internal/flag" | ||
| "github.com/notaryproject/notation/v2/cmd/notation/plugin" | ||
| "github.com/notaryproject/notation/v2/cmd/notation/policy" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func NewRootCommand() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "notation", | ||
| Short: "Notation - a tool to sign and verify artifacts", | ||
| SilenceUsage: true, | ||
| PersistentPreRun: func(cmd *cobra.Command, args []string) { | ||
| // unset registry credentials after read the value from environment | ||
| // to avoid leaking credentials | ||
| os.Unsetenv(flag.EnvironmentUsername) | ||
| os.Unsetenv(flag.EnvironmentPassword) | ||
|
|
||
| // update Notation config directory | ||
| if notationConfig := os.Getenv("NOTATION_CONFIG"); notationConfig != "" { | ||
| dir.UserConfigDir = notationConfig | ||
| } | ||
|
|
||
| // update Notation cache directory | ||
| if notationCache := os.Getenv("NOTATION_CACHE"); notationCache != "" { | ||
| dir.UserCacheDir = notationCache | ||
| } | ||
|
|
||
| // update Notation Libexec directory (for plugins) | ||
| if notationLibexec := os.Getenv("NOTATION_LIBEXEC"); notationLibexec != "" { | ||
| dir.UserLibexecDir = notationLibexec | ||
| } | ||
| }, | ||
| } | ||
| cmd.AddCommand( | ||
| blob.Cmd(), | ||
| signCommand(nil), | ||
| verifyCommand(nil), | ||
| listCommand(nil), | ||
| cert.Cmd(), | ||
| policy.Cmd(), | ||
| keyCommand(), | ||
| plugin.Cmd(), | ||
| loginCommand(nil), | ||
| logoutCommand(nil), | ||
| versionCommand(), | ||
| inspectCommand(nil), | ||
| ) | ||
| return cmd | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,22 +10,25 @@ require ( | |||||
| github.com/opencontainers/go-digest v1.0.0 | ||||||
| github.com/opencontainers/image-spec v1.1.1 | ||||||
| github.com/sirupsen/logrus v1.9.3 | ||||||
| github.com/spf13/cobra v1.9.1 | ||||||
| github.com/spf13/pflag v1.0.7 | ||||||
| github.com/spf13/cobra v1.10.2 | ||||||
| github.com/spf13/pflag v1.0.9 | ||||||
| golang.org/x/term v0.34.0 | ||||||
| oras.land/oras-go/v2 v2.6.0 | ||||||
| ) | ||||||
|
|
||||||
| require ( | ||||||
| github.com/Azure/go-ntlmssp v0.0.0-20221128193559-754e69321358 // indirect | ||||||
| github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect | ||||||
| github.com/fxamacker/cbor/v2 v2.8.0 // indirect | ||||||
| github.com/go-asn1-ber/asn1-ber v1.5.8-0.20250403174932-29230038a667 // indirect | ||||||
| github.com/go-ldap/ldap/v3 v3.4.11 // indirect | ||||||
| github.com/golang-jwt/jwt/v4 v4.5.2 // indirect | ||||||
| github.com/google/uuid v1.6.0 // indirect | ||||||
| github.com/inconshreveable/mousetrap v1.1.0 // indirect | ||||||
| github.com/russross/blackfriday/v2 v2.1.0 // indirect | ||||||
| github.com/veraison/go-cose v1.3.0 // indirect | ||||||
| github.com/x448/float16 v0.8.4 // indirect | ||||||
| go.yaml.in/yaml/v3 v3.0.4 // indirect | ||||||
|
||||||
| go.yaml.in/yaml/v3 v3.0.4 // indirect | |
| gopkg.in/yaml.v3 v3.0.4 // indirect |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where will the CLI reference doc to be generated? From the
cmd/notation/doc.go, will the doc be generated in a new folder created in thenotationrepo?