Skip to content

Commit 78cc5a1

Browse files
author
Automated CI
committed
Publish new documentation for version 0.88.3
1 parent 21d7332 commit 78cc5a1

22 files changed

Lines changed: 314 additions & 1418 deletions

File tree

audit/download/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1840,7 +1840,7 @@ <h3 id="options">Options</h3>
18401840
<td>--file</td>
18411841
<td></td>
18421842
<td>string</td>
1843-
<td>/codefresh/volume/cli/codefresh_audit_2024-11-24_13-20-51.csv</td>
1843+
<td>/codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv</td>
18441844
<td>The name of the file and the directory in which the audit will be saved</td>
18451845
</tr>
18461846
</tbody>

components/index.html

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -853,13 +853,6 @@
853853
<a href="/cli/codefresh-cli-components/">Codefresh CLI components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
854854
</div>
855855
<ul>
856-
<li data-nav-id="/cli/codefresh-cli-components/components/" class="dd-item">
857-
<div>
858-
<a href="/cli/codefresh-cli-components/components/">
859-
components
860-
</a>
861-
</div>
862-
</li>
863856
</ul>
864857
</li>
865858
<li data-nav-id="/cli/components/" class="dd-item parent active haschildren

compositions/index.html

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1313,13 +1313,6 @@
13131313
<a href="/cli/validation/">Validation</a><i class="fa fa-angle-right fa-lg category-icon"></i>
13141314
</div>
13151315
<ul>
1316-
<li data-nav-id="/cli/validation/validate-pipeline-yaml/" class="dd-item">
1317-
<div>
1318-
<a href="/cli/validation/validate-pipeline-yaml/">
1319-
Validate pipeline yaml
1320-
</a>
1321-
</div>
1322-
</li>
13231316
</ul>
13241317
</li>
13251318
<li data-nav-id="/cli/workflow-data/" class="dd-item haschildren

contexts/create-context/create-git-context/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1688,8 +1688,8 @@
16881688
<ul>
16891689
<li><a href="#bitbucket-bitbucket"><a href="bitbucket">bitbucket</a></a></li>
16901690
<li><a href="#github-github"><a href="github">github</a></a></li>
1691-
<li><a href="#stash-stash"><a href="stash">stash</a></a></li>
16921691
<li><a href="#gitlab-gitlab"><a href="gitlab">gitlab</a></a></li>
1692+
<li><a href="#stash-stash"><a href="stash">stash</a></a></li>
16931693
</ul></li>
16941694
</ul></li>
16951695
</ul>
@@ -1730,14 +1730,6 @@ <h3 id="github-github"><a href="github">github</a></h3>
17301730

17311731
<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create Github context you need to generate the token here: <a href="https://github.com/settings/tokens">https://github.com/settings/tokens</a>.</p>
17321732

1733-
<h3 id="stash-stash"><a href="stash">stash</a></h3>
1734-
1735-
<p><code>codefresh create context git stash &lt;name&gt;</code></p>
1736-
1737-
<p>Create a stash context.</p>
1738-
1739-
<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create Stash context you need to provider username and password.</p>
1740-
17411733
<h3 id="gitlab-gitlab"><a href="gitlab">gitlab</a></h3>
17421734

17431735
<p><code>codefresh create context git gitlab &lt;name&gt;</code></p>
@@ -1746,6 +1738,14 @@ <h3 id="gitlab-gitlab"><a href="gitlab">gitlab</a></h3>
17461738

17471739
<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create gitlab context you need to generate the token here: <a href="https://gitlab.com/profile/personal_access_tokens">https://gitlab.com/profile/personal_access_tokens</a>.</p>
17481740

1741+
<h3 id="stash-stash"><a href="stash">stash</a></h3>
1742+
1743+
<p><code>codefresh create context git stash &lt;name&gt;</code></p>
1744+
1745+
<p>Create a stash context.</p>
1746+
1747+
<p>Git context are used to clone repositories during pipeline execution.<br>Learn more about git context here: <a href="https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/">https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/</a>.<br>To create Stash context you need to provider username and password.</p>
1748+
17491749

17501750

17511751

contexts/create-context/create-secret-store-context/index.html

Lines changed: 0 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,62 +1112,6 @@
11121112
<a href="/cli/runtime-environments/">Runtime-Environments</a><i class="fa fa-angle-right fa-lg category-icon"></i>
11131113
</div>
11141114
<ul>
1115-
<li data-nav-id="/cli/runtime-environments/get-runtime-environments/" class="dd-item">
1116-
<div>
1117-
<a href="/cli/runtime-environments/get-runtime-environments/">
1118-
Get Runtime-Environments
1119-
</a>
1120-
</div>
1121-
</li>
1122-
<li data-nav-id="/cli/runtime-environments/delete-runtime-environments/" class="dd-item">
1123-
<div>
1124-
<a href="/cli/runtime-environments/delete-runtime-environments/">
1125-
Delete Runtime-Environments
1126-
</a>
1127-
</div>
1128-
</li>
1129-
<li data-nav-id="/cli/runtime-environments/apply-runtime-environments/" class="dd-item">
1130-
<div>
1131-
<a href="/cli/runtime-environments/apply-runtime-environments/">
1132-
Apply Runtime-Environments
1133-
</a>
1134-
</div>
1135-
</li>
1136-
<li data-nav-id="/cli/runtime-environments/attach-runtime-environments/" class="dd-item">
1137-
<div>
1138-
<a href="/cli/runtime-environments/attach-runtime-environments/">
1139-
Attach Runtime-Environments
1140-
</a>
1141-
</div>
1142-
</li>
1143-
<li data-nav-id="/cli/runtime-environments/create-runtime-environments/" class="dd-item">
1144-
<div>
1145-
<a href="/cli/runtime-environments/create-runtime-environments/">
1146-
Create Runtime-Environments
1147-
</a>
1148-
</div>
1149-
</li>
1150-
<li data-nav-id="/cli/runtime-environments/diff-runtime-environments/" class="dd-item">
1151-
<div>
1152-
<a href="/cli/runtime-environments/diff-runtime-environments/">
1153-
Diff Runtime-Environments
1154-
</a>
1155-
</div>
1156-
</li>
1157-
<li data-nav-id="/cli/runtime-environments/install-runtime-environment/" class="dd-item">
1158-
<div>
1159-
<a href="/cli/runtime-environments/install-runtime-environment/">
1160-
Install Runtime-Environment
1161-
</a>
1162-
</div>
1163-
</li>
1164-
<li data-nav-id="/cli/runtime-environments/uninstall-runtime-environment/" class="dd-item">
1165-
<div>
1166-
<a href="/cli/runtime-environments/uninstall-runtime-environment/">
1167-
Uninstall Runtime-Environment
1168-
</a>
1169-
</div>
1170-
</li>
11711115
</ul>
11721116
</li>
11731117
<li data-nav-id="/cli/runtime-environments-base-images/" class="dd-item haschildren
@@ -1589,21 +1533,6 @@
15891533
Delete Registry
15901534
</a>
15911535
</div>
1592-
</li>
1593-
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
1594-
">
1595-
<div>
1596-
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
1597-
</div>
1598-
<ul>
1599-
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
1600-
<div>
1601-
<a href="/cli/registries/registries/standard/">
1602-
standard
1603-
</a>
1604-
</div>
1605-
</li>
1606-
</ul>
16071536
</li>
16081537
</ul>
16091538
</li>

contexts/create-context/index.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -870,6 +870,20 @@
870870
<a href="/cli/components/">Components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
871871
</div>
872872
<ul>
873+
<li data-nav-id="/cli/components/download/" class="dd-item">
874+
<div>
875+
<a href="/cli/components/download/">
876+
Download
877+
</a>
878+
</div>
879+
</li>
880+
<li data-nav-id="/cli/components/update/" class="dd-item">
881+
<div>
882+
<a href="/cli/components/update/">
883+
Update
884+
</a>
885+
</div>
886+
</li>
873887
</ul>
874888
</li>
875889
<li data-nav-id="/cli/environments/" class="dd-item haschildren

contexts/spec/index.html

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1575,35 +1575,6 @@
15751575
<a href="/cli/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
15761576
</div>
15771577
<ul>
1578-
<li data-nav-id="/cli/registries/get-registries/" class="dd-item">
1579-
<div>
1580-
<a href="/cli/registries/get-registries/">
1581-
Get Registries
1582-
</a>
1583-
</div>
1584-
</li>
1585-
<li data-nav-id="/cli/registries/delete-registry/" class="dd-item">
1586-
<div>
1587-
<a href="/cli/registries/delete-registry/">
1588-
Delete Registry
1589-
</a>
1590-
</div>
1591-
</li>
1592-
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
1593-
">
1594-
<div>
1595-
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
1596-
</div>
1597-
<ul>
1598-
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
1599-
<div>
1600-
<a href="/cli/registries/registries/standard/">
1601-
standard
1602-
</a>
1603-
</div>
1604-
</li>
1605-
</ul>
1606-
</li>
16071578
</ul>
16081579
</li>
16091580

gitops/index.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,34 @@
415415
<a href="/cli/contexts/create-context/create-git-context/">Git</a><i class="fa fa-angle-right fa-lg category-icon"></i>
416416
</div>
417417
<ul>
418+
<li data-nav-id="/cli/contexts/create-context/create-git-context/bitbucket/" class="dd-item">
419+
<div>
420+
<a href="/cli/contexts/create-context/create-git-context/bitbucket/">
421+
bitbucket
422+
</a>
423+
</div>
424+
</li>
425+
<li data-nav-id="/cli/contexts/create-context/create-git-context/github/" class="dd-item">
426+
<div>
427+
<a href="/cli/contexts/create-context/create-git-context/github/">
428+
github
429+
</a>
430+
</div>
431+
</li>
432+
<li data-nav-id="/cli/contexts/create-context/create-git-context/gitlab/" class="dd-item">
433+
<div>
434+
<a href="/cli/contexts/create-context/create-git-context/gitlab/">
435+
gitlab
436+
</a>
437+
</div>
438+
</li>
439+
<li data-nav-id="/cli/contexts/create-context/create-git-context/stash/" class="dd-item">
440+
<div>
441+
<a href="/cli/contexts/create-context/create-git-context/stash/">
442+
stash
443+
</a>
444+
</div>
445+
</li>
418446
</ul>
419447
</li>
420448
<li data-nav-id="/cli/contexts/create-context/create-helm-repository-context/" class="dd-item haschildren

gitops/install/index.html

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1587,21 +1587,6 @@
15871587
Delete Registry
15881588
</a>
15891589
</div>
1590-
</li>
1591-
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
1592-
">
1593-
<div>
1594-
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
1595-
</div>
1596-
<ul>
1597-
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
1598-
<div>
1599-
<a href="/cli/registries/registries/standard/">
1600-
standard
1601-
</a>
1602-
</div>
1603-
</li>
1604-
</ul>
16051590
</li>
16061591
</ul>
16071592
</li>

index.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -900,7 +900,7 @@
900900
"title": "Download",
901901
"tags": [],
902902
"description": "",
903-
"content": " Description Download audit.\nCommand codefresh download audit\nOptions Option Alias Type Default Description --help Print help information --userName filter by user name --userId filter by codefresh user id --entity filter by api entity, example: pipeline, account --entityId filter by api entity id, this value different for each action, example: email, user id --action filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account --rs_status filter by response status code --showTriggers returns only actions related to receiving triggers --search filter by searching substring in request body or query or params or headers or url --from filter by date, value is number of milliseconds since 1970 --to filter by date, value is number of milliseconds since 1970 --sortField name of sorting field, values: id, createdAt, updatedAt\nPossible values:\n- id\n- createdAt\n- updatedAt --sortType sorting type, values: ASK, DESK\nPossible values:\n- ASK\n- DESK --file string /codefresh/volume/cli/codefresh_audit_2024-11-24_13-20-51.csv The name of the file and the directory in which the audit will be saved Examples undefined codefresh download audit --file /var/www/audit.csv\nundefined --entity account --rs_status 200 --sortType DESK --sortField createdAt\n"
903+
"content": " Description Download audit.\nCommand codefresh download audit\nOptions Option Alias Type Default Description --help Print help information --userName filter by user name --userId filter by codefresh user id --entity filter by api entity, example: pipeline, account --entityId filter by api entity id, this value different for each action, example: email, user id --action filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account --rs_status filter by response status code --showTriggers returns only actions related to receiving triggers --search filter by searching substring in request body or query or params or headers or url --from filter by date, value is number of milliseconds since 1970 --to filter by date, value is number of milliseconds since 1970 --sortField name of sorting field, values: id, createdAt, updatedAt\nPossible values:\n- id\n- createdAt\n- updatedAt --sortType sorting type, values: ASK, DESK\nPossible values:\n- ASK\n- DESK --file string /codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv The name of the file and the directory in which the audit will be saved Examples undefined codefresh download audit --file /var/www/audit.csv\nundefined --entity account --rs_status 200 --sortType DESK --sortField createdAt\n"
904904
},
905905
{
906906
"uri": "https://codefresh-io.github.io/cli/more/image-pull-secret/",
@@ -949,7 +949,7 @@
949949
"title": "Triggers",
950950
"tags": [],
951951
"description": "",
952-
"content": " [Deprecated] Create Pipeline Trigger codefresh create trigger [event-uri] [pipeline]\n[Deprecated] Create trigger: link pipeline to trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Triggers codefresh get triggers\n[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers.\nOnly cron/registry triggers are supported (for git triggers use codefresh get pip \u0026lt;pip-name\u0026gt; -o json).\n[Deprecated] Get Trigger Event codefresh get trigger-events [event-uri]\n[Deprecated] Get trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Trigger Types codefresh get trigger-types\n[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger codefresh delete trigger [event-uri] [pipeline]\nDelete trigger: unlink pipeline from trigger-event.\n[Deprecated] Create Trigger Event codefresh create trigger-event\n[Deprecated] Create new trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Trigger Event codefresh delete trigger-event [event-uri]\n[Deprecated] Delete trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n"
952+
"content": " [Deprecated] Create Pipeline Trigger codefresh create trigger [event-uri] [pipeline]\n[Deprecated] Create trigger: link pipeline to trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Triggers codefresh get triggers\n[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers.\nOnly cron/registry triggers are supported (for git triggers use codefresh get pip \u0026lt;pip-name\u0026gt; -o json).\n[Deprecated] Get Trigger Types codefresh get trigger-types\n[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Trigger Event codefresh get trigger-events [event-uri]\n[Deprecated] Get trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger codefresh delete trigger [event-uri] [pipeline]\nDelete trigger: unlink pipeline from trigger-event.\n[Deprecated] Create Trigger Event codefresh create trigger-event\n[Deprecated] Create new trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Trigger Event codefresh delete trigger-event [event-uri]\n[Deprecated] Delete trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n"
953953
},
954954
{
955955
"uri": "https://codefresh-io.github.io/cli/contexts/update-context/",
@@ -1117,7 +1117,7 @@
11171117
"title": "Git",
11181118
"tags": [],
11191119
"description": "",
1120-
"content": " bitbucket codefresh create context git bitbucket \u0026lt;name\u0026gt;\nCreate a bitbucket context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create bitbucket context you need to generate application password from here: https://bitbucket.org/account/user/{YOUR-USERNAME}/app-passwords.\ngithub codefresh create context git github \u0026lt;name\u0026gt;\nCreate a github context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Github context you need to generate the token here: https://github.com/settings/tokens.\nstash codefresh create context git stash \u0026lt;name\u0026gt;\nCreate a stash context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Stash context you need to provider username and password.\ngitlab codefresh create context git gitlab \u0026lt;name\u0026gt;\nCreate a gitlab context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.\n"
1120+
"content": " bitbucket codefresh create context git bitbucket \u0026lt;name\u0026gt;\nCreate a bitbucket context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create bitbucket context you need to generate application password from here: https://bitbucket.org/account/user/{YOUR-USERNAME}/app-passwords.\ngithub codefresh create context git github \u0026lt;name\u0026gt;\nCreate a github context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Github context you need to generate the token here: https://github.com/settings/tokens.\ngitlab codefresh create context git gitlab \u0026lt;name\u0026gt;\nCreate a gitlab context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.\nstash codefresh create context git stash \u0026lt;name\u0026gt;\nCreate a stash context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Stash context you need to provider username and password.\n"
11211121
},
11221122
{
11231123
"uri": "https://codefresh-io.github.io/cli/gitops/",

0 commit comments

Comments
 (0)