Skip to content

Commit afd5313

Browse files
ghes-botghes-bot
committed
Update generated docs for 3.15.0
1 parent 637db01 commit afd5313

File tree

2 files changed

+85
-3
lines changed

2 files changed

+85
-3
lines changed

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ To install the latest version, use:
1414
gh extension install github.com/github/gh-es
1515
```
1616

17-
Please make sure to install the correct version of the CLI extension which matches the release version (e.g. `3.14.0`) of your GHES installation, by pinning to the latest patch for the corresponding release series:
17+
Please make sure to install the correct version of the CLI extension which matches the release version (e.g. `3.15.0`) of your GHES installation, by pinning to the latest patch for the corresponding release series:
1818

1919
```bash
20-
gh extension install github.com/github/gh-es --pin v3.14.0
20+
gh extension install github.com/github/gh-es --pin v3.15.0
2121
```
2222

2323
## Supported versions
@@ -27,7 +27,8 @@ The following versions of GHES are supported by this CLI. Please refer to the [U
2727
* [3.11](https://github.com/github/gh-es/blob/3.11/README.md)
2828
* [3.12](https://github.com/github/gh-es/blob/3.12/README.md)
2929
* [3.13](https://github.com/github/gh-es/blob/3.13/README.md)
30-
* [3.14](https://github.com/github/gh-es/blob/main/README.md)
30+
* [3.14](https://github.com/github/gh-es/blob/3.14/README.md)
31+
* [3.15](https://github.com/github/gh-es/blob/main/README.md)
3132

3233
## Usage
3334

‎USAGE.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ Configures the CLI to be able to connect with the Manage GitHub Enterprise Serve
4242

4343

4444
<dl class="flags">
45+
<dt><code>--address &lt;string&gt;</code></dt>
46+
<dd>The address of the GHES server</dd>
47+
4548
<dt><code>--json</code></dt>
4649
<dd>Format results as JSON</dd>
4750
</dl>
@@ -78,6 +81,9 @@ Ping the GitHub Enterprise Server instance and verify the stored API credentials
7881

7982

8083
<dl class="flags">
84+
<dt><code>--address &lt;string&gt;</code></dt>
85+
<dd>The address of the GHES server</dd>
86+
8187
<dt><code>--json</code></dt>
8288
<dd>Format results as JSON</dd>
8389
</dl>
@@ -108,6 +114,9 @@ In the case that the CLI is currently configured using the root site administrat
108114

109115

110116
<dl class="flags">
117+
<dt><code>--address &lt;string&gt;</code></dt>
118+
<dd>The address of the GHES server</dd>
119+
111120
<dt><code>--json</code></dt>
112121
<dd>Format results as JSON</dd>
113122
</dl>
@@ -131,6 +140,9 @@ Get SSH keys from the authorized_keys file on all configured nodes.
131140

132141

133142
<dl class="flags">
143+
<dt><code>--address &lt;string&gt;</code></dt>
144+
<dd>The address of the GHES server</dd>
145+
134146
<dt><code>--json</code></dt>
135147
<dd>Format results as JSON</dd>
136148
</dl>
@@ -167,6 +179,9 @@ Add SSH key to the authorized_keys file on all configured nodes.
167179

168180

169181
<dl class="flags">
182+
<dt><code>--address &lt;string&gt;</code></dt>
183+
<dd>The address of the GHES server</dd>
184+
170185
<dt><code>--json</code></dt>
171186
<dd>Format results as JSON</dd>
172187
</dl>
@@ -206,6 +221,9 @@ Remove SSH key from the authorized_keys file on all configured nodes.
206221

207222

208223
<dl class="flags">
224+
<dt><code>--address &lt;string&gt;</code></dt>
225+
<dd>The address of the GHES server</dd>
226+
209227
<dt><code>--json</code></dt>
210228
<dd>Format results as JSON</dd>
211229
</dl>
@@ -248,6 +266,9 @@ Get the status of services running on each cluster node.
248266

249267

250268
<dl class="flags">
269+
<dt><code>--address &lt;string&gt;</code></dt>
270+
<dd>The address of the GHES server</dd>
271+
251272
<dt><code>--json</code></dt>
252273
<dd>Format results as JSON</dd>
253274
</dl>
@@ -277,6 +298,9 @@ Bootstrap the GitHub Enterprise Server instance by initializing the configuratio
277298

278299

279300
<dl class="flags">
301+
<dt><code>--address &lt;string&gt;</code></dt>
302+
<dd>The address of the GHES server</dd>
303+
280304
<dt><code>--json</code></dt>
281305
<dd>Format results as JSON</dd>
282306
</dl>
@@ -306,6 +330,9 @@ Get GHES metadata for all configured nodes.
306330

307331

308332
<dl class="flags">
333+
<dt><code>--address &lt;string&gt;</code></dt>
334+
<dd>The address of the GHES server</dd>
335+
309336
<dt><code>--json</code></dt>
310337
<dd>Format results as JSON</dd>
311338
</dl>
@@ -332,6 +359,9 @@ Initiate a config-apply run on all configured nodes.
332359

333360

334361
<dl class="flags">
362+
<dt><code>--address &lt;string&gt;</code></dt>
363+
<dd>The address of the GHES server</dd>
364+
335365
<dt><code>--json</code></dt>
336366
<dd>Format results as JSON</dd>
337367
</dl>
@@ -371,6 +401,9 @@ Check config apply status on all configured nodes.
371401

372402

373403
<dl class="flags">
404+
<dt><code>--address &lt;string&gt;</code></dt>
405+
<dd>The address of the GHES server</dd>
406+
374407
<dt><code>--json</code></dt>
375408
<dd>Format results as JSON</dd>
376409
</dl>
@@ -419,6 +452,9 @@ Check config apply events on all configured nodes.
419452

420453

421454
<dl class="flags">
455+
<dt><code>--address &lt;string&gt;</code></dt>
456+
<dd>The address of the GHES server</dd>
457+
422458
<dt><code>--json</code></dt>
423459
<dd>Format results as JSON</dd>
424460
</dl>
@@ -452,6 +488,9 @@ Display the license information. Provide information about topology, seat counts
452488

453489

454490
<dl class="flags">
491+
<dt><code>--address &lt;string&gt;</code></dt>
492+
<dd>The address of the GHES server</dd>
493+
455494
<dt><code>--json</code></dt>
456495
<dd>Format results as JSON</dd>
457496
</dl>
@@ -469,6 +508,9 @@ Check the license information. Perform various checks like expiration date, topo
469508

470509

471510
<dl class="flags">
511+
<dt><code>--address &lt;string&gt;</code></dt>
512+
<dd>The address of the GHES server</dd>
513+
472514
<dt><code>--json</code></dt>
473515
<dd>Format results as JSON</dd>
474516
</dl>
@@ -498,6 +540,9 @@ Import a new license. This does not immediately apply the license to the GitHub
498540

499541

500542
<dl class="flags">
543+
<dt><code>--address &lt;string&gt;</code></dt>
544+
<dd>The address of the GHES server</dd>
545+
501546
<dt><code>--json</code></dt>
502547
<dd>Format results as JSON</dd>
503548
</dl>
@@ -524,6 +569,9 @@ Get current settings of the GitHub Enterprise Server instance, which are ready t
524569

525570

526571
<dl class="flags">
572+
<dt><code>--address &lt;string&gt;</code></dt>
573+
<dd>The address of the GHES server</dd>
574+
527575
<dt><code>--json</code></dt>
528576
<dd>Format results as JSON</dd>
529577
</dl>
@@ -553,6 +601,9 @@ Update a subset or all of GHES settings in preparation to applying them.
553601

554602

555603
<dl class="flags">
604+
<dt><code>--address &lt;string&gt;</code></dt>
605+
<dd>The address of the GHES server</dd>
606+
556607
<dt><code>--json</code></dt>
557608
<dd>Format results as JSON</dd>
558609
</dl>
@@ -601,6 +652,9 @@ Configure the maintenance mode on all configured or specific UUID-identified no
601652

602653

603654
<dl class="flags">
655+
<dt><code>--address &lt;string&gt;</code></dt>
656+
<dd>The address of the GHES server</dd>
657+
604658
<dt><code>--json</code></dt>
605659
<dd>Format results as JSON</dd>
606660
</dl>
@@ -652,6 +706,9 @@ Check maintenance status on all configured nodes.
652706

653707

654708
<dl class="flags">
709+
<dt><code>--address &lt;string&gt;</code></dt>
710+
<dd>The address of the GHES server</dd>
711+
655712
<dt><code>--json</code></dt>
656713
<dd>Format results as JSON</dd>
657714
</dl>
@@ -694,6 +751,9 @@ Get GHES version for all configured nodes.
694751

695752

696753
<dl class="flags">
754+
<dt><code>--address &lt;string&gt;</code></dt>
755+
<dd>The address of the GHES server</dd>
756+
697757
<dt><code>--json</code></dt>
698758
<dd>Format results as JSON</dd>
699759
</dl>
@@ -726,6 +786,9 @@ Show replication status for each replication channel to the primary.
726786

727787

728788
<dl class="flags">
789+
<dt><code>--address &lt;string&gt;</code></dt>
790+
<dd>The address of the GHES server</dd>
791+
729792
<dt><code>--json</code></dt>
730793
<dd>Format results as JSON</dd>
731794
</dl>
@@ -743,6 +806,9 @@ Get topology configuration from the GHES instance in INI style.
743806

744807

745808
<dl class="flags">
809+
<dt><code>--address &lt;string&gt;</code></dt>
810+
<dd>The address of the GHES server</dd>
811+
746812
<dt><code>--json</code></dt>
747813
<dd>Format results as JSON</dd>
748814
</dl>
@@ -769,6 +835,9 @@ Set GHES topology configuration by providing a path to the cluster configuration
769835

770836

771837
<dl class="flags">
838+
<dt><code>--address &lt;string&gt;</code></dt>
839+
<dd>The address of the GHES server</dd>
840+
772841
<dt><code>--json</code></dt>
773842
<dd>Format results as JSON</dd>
774843
</dl>
@@ -801,6 +870,9 @@ Verify GHES topology configuration by providing a path to the cluster configurat
801870
802871
803872
<dl class="flags">
873+
<dt><code>--address &lt;string&gt;</code></dt>
874+
<dd>The address of the GHES server</dd>
875+
804876
<dt><code>--json</code></dt>
805877
<dd>Format results as JSON</dd>
806878
</dl>
@@ -833,6 +905,9 @@ Compares the existing GHES topology configurations with a provided cluster confi
833905
834906
835907
<dl class="flags">
908+
<dt><code>--address &lt;string&gt;</code></dt>
909+
<dd>The address of the GHES server</dd>
910+
836911
<dt><code>--json</code></dt>
837912
<dd>Format results as JSON</dd>
838913
</dl>
@@ -868,6 +943,9 @@ Check if the configured cluster nodes meet the minimum system requirements in te
868943
869944
870945
<dl class="flags">
946+
<dt><code>--address &lt;string&gt;</code></dt>
947+
<dd>The address of the GHES server</dd>
948+
871949
<dt><code>--json</code></dt>
872950
<dd>Format results as JSON</dd>
873951
</dl>
@@ -897,6 +975,9 @@ Check if esstential ports are reachable on the cluster nodes.
897975
898976
899977
<dl class="flags">
978+
<dt><code>--address &lt;string&gt;</code></dt>
979+
<dd>The address of the GHES server</dd>
980+
900981
<dt><code>--json</code></dt>
901982
<dd>Format results as JSON</dd>
902983
</dl>

0 commit comments

Comments
 (0)