Revert "Generate docs on every commit (#683)" (#689)

This reverts commit 7db0e9b.
nats-io · Jan 2, 2025 · e267e48 · e267e48
1 parent 7db0e9b
commit e267e48
Show file tree

Hide file tree

Showing 81 changed files with 385 additions and 848 deletions.
diff --git a/.github/workflows/pushes.yaml b/.github/workflows/pushes.yaml
@@ -29,9 +29,6 @@ on:
 jobs:
   test:
     runs-on: ${{ matrix.os }}
-    permissions:
-      contents: write
-
     continue-on-error: ${{ matrix.experimental || false }}
     strategy:
       # Debugging multi-platform builds, let them all complete (for now)
@@ -55,7 +52,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.head_ref }}
           fetch-depth: 0
 
       - name: Set up Go
@@ -129,17 +125,6 @@ jobs:
           COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: matrix.canonical
 
-      - name: Generate docs
-        run: go run ./ test doc docs
-        if: matrix.os == 'ubuntu-latest'
-
-      - name: Auto-commit generated docs
-        uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: Auto-commit docs
-          file_pattern: docs/**
-        if: matrix.os == 'ubuntu-latest'
-
       - name: Bad versions creep defense
         id: go-module-versions
         # The go.mod includes tests, and some of our tests explicitly pull in jwtv1, which is unmaintained and has security issues.

diff --git a/docs/nsc.md b/docs/nsc.md
@@ -2,14 +2,13 @@
 
 nsc creates NATS operators, accounts, users, and manage their permissions.
 
-```
-nsc [flags]
-```
+### Synopsis
+
+nsc creates NATS operators, accounts, users, and manage their permissions.
 
 ### Options
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -h, --help                  help for nsc
@@ -18,32 +17,27 @@ nsc [flags]
   -K, --private-key string    Key used to sign. Can be specified as role (where applicable),
                               public key (private portion is retrieved)
                               or file path to a private key or private key 
-  -v, --version               version for nsc
 ```
 
 ### SEE ALSO
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
-* [nsc completion](nsc_completion.md)	 - Generate the autocompletion script for the specified shell
 * [nsc delete](nsc_delete.md)	 - Delete imports and exports
 * [nsc describe](nsc_describe.md)	 - Describe assets such as operators, accounts, users, and jwt files
 * [nsc edit](nsc_edit.md)	 - Edit assets such as accounts, imports, and users
 * [nsc env](nsc_env.md)	 - Prints and manage the nsc environment
-* [nsc expirations](nsc_expirations.md)	 - Create a new expiration report
 * [nsc export](nsc_export.md)	 - Export assets such as nkeys
 * [nsc generate](nsc_generate.md)	 - Generate activations, creds, configs or nkeys
 * [nsc import](nsc_import.md)	 - Import assets such as nkeys
 * [nsc init](nsc_init.md)	 - Initialize an environment by creating an operator, account and user
 * [nsc keys](nsc_keys.md)	 - Manage keys for operators, accounts, and users
 * [nsc list](nsc_list.md)	 - List assets such as accounts, imports, users
-* [nsc load](nsc_load.md)	 - install entities for an operator, account and key
 * [nsc pull](nsc_pull.md)	 - Pull an operator or account jwt replacing the local jwt with the server's version
 * [nsc push](nsc_push.md)	 - Push an account jwt to an Account JWT Server
 * [nsc reissue](nsc_reissue.md)	 - Re-issue objects with a new identity key
 * [nsc revocations](nsc_revocations.md)	 - Manage revocation for users and activations from an account
-* [nsc select](nsc_select.md)	 - Set the current operator or account
 * [nsc tool](nsc_tool.md)	 - NATS tools: pub, sub, req, rep, rtt
 * [nsc update](nsc_update.md)	 - Update this tool to latest version
 * [nsc validate](nsc_validate.md)	 - Validate an operator, account(s), and users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add.md b/docs/nsc_add.md
@@ -2,6 +2,10 @@
 
 Add assets such as accounts, imports, users
 
+### Synopsis
+
+Add assets such as accounts, imports, users
+
 ### Options
 
 ```
@@ -11,7 +15,6 @@ Add assets such as accounts, imports, users
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -31,4 +34,4 @@ Add assets such as accounts, imports, users
 * [nsc add operator](nsc_add_operator.md)	 - Add an operator
 * [nsc add user](nsc_add_user.md)	 - Add an user to the account
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add_account.md b/docs/nsc_add_account.md
@@ -2,6 +2,10 @@
 
 Add an account
 
+### Synopsis
+
+Add an account
+
 ```
 nsc add account [flags]
 ```
@@ -16,18 +20,17 @@ nsc add account [flags]
       --deny-pub strings             add deny publish default permissions - comma separated list or option can be specified multiple times
       --deny-pubsub strings          add deny publish and subscribe default permissions - comma separated list or option can be specified multiple times
       --deny-sub strings             add deny subscribe default permissions - comma separated list or option can be specified multiple times
-      --expiry string                valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears)
+      --expiry string                valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0")
   -h, --help                         help for account
   -n, --name string                  account name
   -k, --public-key string            public key identifying the account
       --response-ttl string          the amount of time the default permissions is valid (global) - [#ms(millis) | #s(econds) | m(inutes) | h(ours)] - Default is no time limit.
-      --start string                 valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears)
+      --start string                 valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0")
 ```
 
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -41,4 +44,4 @@ nsc add account [flags]
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add_export.md b/docs/nsc_add_export.md
@@ -2,6 +2,10 @@
 
 Add an export
 
+### Synopsis
+
+Add an export
+
 ```
 nsc add export [flags]
 ```
@@ -20,7 +24,6 @@ nsc add export --name myexport --subject a.b --service
 ```
   -a, --account string                account name
       --account-token-position uint   subject token position where account is expected (public exports only)
-      --allow-trace                   allow trace requests
   -h, --help                          help for export
       --latency string                latency metrics subject (services only)
   -n, --name string                   export name
@@ -35,7 +38,6 @@ nsc add export --name myexport --subject a.b --service
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -49,4 +51,4 @@ nsc add export --name myexport --subject a.b --service
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add_import.md b/docs/nsc_add_import.md
@@ -2,6 +2,10 @@
 
 Add an import
 
+### Synopsis
+
+Add an import
+
 ```
 nsc add import [flags]
 ```
@@ -19,7 +23,6 @@ nsc add import --src-account <account_pubkey> --remote-subject <remote-sub> --lo
 
 ```
   -a, --account string          account name
-      --allow-trace             allow trace requests
   -h, --help                    help for import
   -s, --local-subject string    local subject
   -n, --name string             import name
@@ -33,7 +36,6 @@ nsc add import --src-account <account_pubkey> --remote-subject <remote-sub> --lo
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -47,4 +49,4 @@ nsc add import --src-account <account_pubkey> --remote-subject <remote-sub> --lo
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add_mapping.md b/docs/nsc_add_mapping.md
@@ -2,6 +2,10 @@
 
 Add (or modify) a mapping entry
 
+### Synopsis
+
+Add (or modify) a mapping entry
+
 ```
 nsc add mapping [flags]
 ```
@@ -31,7 +35,6 @@ nsc add mapping --from "a" --to "c" --weight 50
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -45,4 +48,4 @@ nsc add mapping --from "a" --to "c" --weight 50
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add_operator.md b/docs/nsc_add_operator.md
@@ -2,27 +2,30 @@
 
 Add an operator
 
+### Synopsis
+
+Add an operator
+
 ```
 nsc add operator [flags]
 ```
 
 ### Options
 
 ```
-      --expiry string          valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears)
+      --expiry string          valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0")
       --force                  on import, overwrite existing when already present
       --generate-signing-key   generate a signing key with the operator
   -h, --help                   help for operator
   -n, --name string            operator name
-      --start string           valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears)
+      --start string           valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0")
   -s, --sys                    generate system account with the operator (if specified will be signed with signing key)
   -u, --url string             import from a jwt server url, file, or well known operator
 ```
 
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -36,4 +39,4 @@ nsc add operator [flags]
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_add_user.md b/docs/nsc_add_user.md
@@ -2,6 +2,10 @@
 
 Add an user to the account
 
+### Synopsis
+
+Add an user to the account
+
 ```
 nsc add user [flags]
 ```
@@ -54,20 +58,19 @@ nsc add user --name <n> --allow-pub-response=5
       --deny-pub strings             add deny publish permissions - comma separated list or option can be specified multiple times
       --deny-pubsub strings          add deny publish and subscribe permissions - comma separated list or option can be specified multiple times
       --deny-sub strings             add deny subscribe permissions - comma separated list or option can be specified multiple times
-      --expiry string                valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears)
+      --expiry string                valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0")
   -h, --help                         help for user
   -n, --name string                  name to assign the user
   -k, --public-key string            public key identifying the user
       --response-ttl string          the amount of time the permissions is valid (global) - [#ms(millis) | #s(econds) | m(inutes) | h(ours)] - Default is no time limit.
       --source-network strings       source network for connection - comma separated list or option can be specified multiple times
-      --start string                 valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears)
+      --start string                 valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0")
       --tag strings                  tags for user - comma separated list or option can be specified multiple times
 ```
 
 ### Options inherited from parent commands
 
 ```
-  -H, --all-dirs string       sets --config-dir, --data-dir, and --keystore-dir to the same value
       --config-dir string     nsc config directory
       --data-dir string       nsc data store directory
   -i, --interactive           ask questions for various settings
@@ -81,4 +84,4 @@ nsc add user --name <n> --allow-pub-response=5
 
 * [nsc add](nsc_add.md)	 - Add assets such as accounts, imports, users
 
-###### Auto generated by spf13/cobra on 18-Dec-2024
+###### Auto generated by spf13/cobra on 25-Feb-2022
diff --git a/docs/nsc_completion.md b/docs/nsc_completion.md