Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ RUN apk --update add --no-cache \
jq
RUN npm upgrade -g npm
COPY --from=mikefarah/yq:4.52.4 /usr/bin/yq /usr/local/bin/yq
ADD --chmod=775 https://dl.k8s.io/release/v1.35.1/bin/${TARGETPLATFORM}/kubectl /usr/local/bin/kubectl
ADD --chmod=775 https://dl.k8s.io/release/v1.35.3/bin/${TARGETPLATFORM}/kubectl /usr/local/bin/kubectl
WORKDIR /cf-cli
COPY package.json yarn.lock check-version.js run-check-version.js /cf-cli/
RUN yarn install --prod --frozen-lockfile && \
Expand Down
5 changes: 5 additions & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ highlightClientSide = false # set true to use highlight.pack.js instead of the d
[blackfriday]
smartDashes = false

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true

[outputs]
home = [ "HTML", "RSS", "JSON"]

Expand Down
12 changes: 6 additions & 6 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ weight = 1

Welcome to Codefresh official CLI documentation!

The Codefresh CLI provides a full and flexible interface to interact with Codefresh.<br>
The Codefresh CLI provides a full and flexible interface to interact with Codefresh.

The CLI can be used to achieve the following:
<ul>
<li>Perform any operation you would be able to do through the UI.</li>
<li>Create complex automation from your local machine.</li>
<li>Run complex pipeline use cases by using the CLI inside your pipeline steps.</li>
</ul>

- Perform any operation you would be able to do through the UI.
- Create complex automation from your local machine.
- Run complex pipeline use cases by using the CLI inside your pipeline steps.

To get started please navigate to the [Getting started](getting-started) page.
23 changes: 12 additions & 11 deletions docs/content/contexts/spec/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,20 @@ A Context needs `.apiVersion`, `.kind`, and `.metadata` fields.
A Context also needs a `.spec` section.

### Owner
A context can be either attached to a user or to an account.<br>
`.owner` can be either `account` or `user`. <br>
The default is `account`. <br>
A context can be either attached to a user or to an account.

`.owner` can be either `account` or `user`.

The default is `account`.

### Type
`.spec.type` should be one of the following: <br>
<ul>
<li>[config](config) </li>
<li>[secret](secret) </li>
<li>[yaml](yaml) </li>
<li>[secret-yaml](secret-yaml) </li>
<li>[helm-repository](helm-repository) </li>
</ul>
`.spec.type` should be one of the following:

- [config](config)
- [secret](secret)
- [yaml](yaml)
- [secret-yaml](secret-yaml)
- [helm-repository](helm-repository)

### Data
`.spec.data` should be different according to the type of the context
Expand Down
22 changes: 13 additions & 9 deletions docs/content/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,24 @@ weight = 10
Install the CLI through one of the possible ways described in the [Installation](/cli/installation) page.

## Authenticate
In order to start working with the cli you will need to update the authentication configuration. <br />
Updating the authentication configuration is done via an API-KEY you generate from Codefresh. <br />
In order to start working with the cli you will need to update the authentication configuration.

If you already have an API-KEY you can just use it.<br />
You can generate a new one from the <a href="https://g.codefresh.io/user/settings" target="_blank">user settings</a> page. <br />

Once you have an API key, create a new authentication context:<br> `codefresh auth create-context --api-key {API_KEY}`
Updating the authentication configuration is done via an API-KEY you generate from Codefresh.

If you already have an API-KEY you can just use it.

You can generate a new one from the [user settings](https://g.codefresh.io/user/settings) page.

Once you have an API key, create a new authentication context:

`codefresh auth create-context --api-key {API_KEY}`

## Getting Help
To get help and usage instructions run `codefresh [COMMAND]--help`.<br />
A help message will appear in the terminal.<br />
To get help and usage instructions run `codefresh [COMMAND]--help`.

A help message will appear in the terminal.

## Showing Current Version
Run `codefresh version` to see the current CLI version.

<br />
#### That's it, you are good to go!
6 changes: 3 additions & 3 deletions docs/content/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ description = ""
weight = 20
+++

Codefresh CLI is developed and built with node.js. <br />
Codefresh CLI is developed and built with node.js.

In case you have node.js installed on your machine you can use [NPM](/cli/installation/npm) or [YARN](/cli/installation/yarn) to install it.<br>
In case you have node.js installed on your machine you can use [NPM](/cli/installation/npm) or [YARN](/cli/installation/yarn) to install it.

If you don't have node.js installed you can install the CLI by [Downloading](/cli/installation/download) it directly.<br />
If you don't have node.js installed you can install the CLI by [Downloading](/cli/installation/download) it directly.

It is also possible to run the CLI using a [Docker image](/cli/installation/docker).
2 changes: 1 addition & 1 deletion docs/content/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date = "2017-04-24T18:36:24+02:00"
weight = 30
+++

You can run the CLI using our official docker image which is published to <a href="https://hub.docker.com/r/codefresh/cli/" target="_blank">Dockerhub</a><br>
You can run the CLI using our official docker image which is published to [Dockerhub](https://hub.docker.com/r/codefresh/cli/).

Pull the latest version:
`docker pull codefresh/cli`
Expand Down
6 changes: 4 additions & 2 deletions docs/content/operate on resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ title = "Operate On Resources"
weight = 31
+++

The CLI supports the ability to work with `spec` files when working with resources.<br>
The supported formats are `yaml` and `json`. <br>
The CLI supports the ability to work with `spec` files when working with resources.

The supported formats are `yaml` and `json`.

Check each specific resource `spec` for its documentation

{{COMMANDS}}
6 changes: 4 additions & 2 deletions docs/content/pipelines/Run Pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@
{{OPTIONS}}

### variable-file (var-file)
It is possible to pass build variables using a file. (supported format: json and yaml) <br>
The variables file structure should be an array. <br>
It is possible to pass build variables using a file. (supported format: json and yaml)

The variables file structure should be an array.

The pipeline will be triggered multiple times according to the array length.

#### Variable yaml file with 2 sets of variables
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<script type="text/javascript" src="{{"js/auto-complete.js" | relURL}}"></script>
<link href="{{"css/auto-complete.css" | relURL}}" rel="stylesheet">
<script type="text/javascript">
{{ if .Site.IsMultiLingual }}
{{ if hugo.IsMultilingual }}
var baseurl = "{{.Site.BaseURL}}{{.Site.LanguagePrefix}}";
{{ else }}
var baseurl = "{{.Site.BaseURL}}";
Expand Down
2 changes: 1 addition & 1 deletion docs/themes/docdock/layouts/partials/flex/head.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
{{ .Hugo.Generator }}
{{ hugo.Generator }}
<title>{{ .Title }} :: {{ .Site.Title }}</title>
<link rel="shortcut icon" href="{{"images/favicon.png" | relURL}}" type="image/x-icon" />
<link href="{{"css/font-awesome.min.css" | relURL}}" rel="stylesheet">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{- if and .Site.IsMultiLingual (not .Site.Params.DisableLanguageSwitchingButton)}}
{{- if and hugo.IsMultilingual (not .Site.Params.DisableLanguageSwitchingButton)}}
<select id="select-language" onchange="location = this.value;">
{{ $siteLanguages := .Site.Languages}}
{{ $pageLang := .Page.Lang}}
Expand Down
8 changes: 4 additions & 4 deletions docs/themes/docdock/layouts/partials/menu.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
{{- if and .IsSection (or (not .Params.hidden) $.showhidden)}}
{{- $numberOfPages := (add (len .Pages) (len .Sections)) }}
{{- safeHTML .Params.head}}
<li data-nav-id="{{.URL}}" class="dd-item
<li data-nav-id="{{.RelPermalink}}" class="dd-item
{{- if .IsAncestor $currentNode}} parent{{end}}
{{- if eq .URL $currentNode.URL}} active{{end}}
{{- if eq .RelPermalink $currentNode.RelPermalink}} active{{end}}
{{- if .Params.alwaysopen}} alwaysopen{{end -}}
{{- if ne $numberOfPages 0 }} haschildren{{end}}
">
Expand Down Expand Up @@ -66,8 +66,8 @@
</li>
{{- else}}
{{- if not .Params.Hidden }}
<li data-nav-id="{{.URL}}" class="dd-item
{{- if eq .URL $currentNode.URL}} active{{end -}}
<li data-nav-id="{{.RelPermalink}}" class="dd-item
{{- if eq .RelPermalink $currentNode.RelPermalink}} active{{end -}}
">
<div>
<a href="{{ .RelPermalink}}">
Expand Down
6 changes: 3 additions & 3 deletions docs/themes/docdock/layouts/partials/next-prev-page.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{{- define "menu-nextprev" -}}
{{- $currentNode := .currentnode -}}
{{- if ne .menu.Params.hidden true -}}
{{- if hasPrefix $currentNode.URL .menu.URL -}}
{{- if hasPrefix $currentNode.RelPermalink .menu.RelPermalink -}}
{{- $currentNode.Scratch.Set "NextPageOK" "OK" -}}
{{- $currentNode.Scratch.Set "prevPage" ($currentNode.Scratch.Get "prevPageTmp") -}}
{{- else -}}
Expand Down Expand Up @@ -35,10 +35,10 @@

{{- if not $.Site.Params.disableNavChevron -}}
{{- with ($.Scratch.Get "prevPage") -}}
<a class="nav nav-prev" href="{{.URL}}" title="{{.Title}}"> <i class="fa fa-chevron-left"></i><label>{{.Title}}</label></a>
<a class="nav nav-prev" href="{{.RelPermalink}}" title="{{.Title}}"> <i class="fa fa-chevron-left"></i><label>{{.Title}}</label></a>
{{ end -}}
{{- with ($.Scratch.Get "nextPage") -}}
<a class="nav nav-next" href="{{.URL}}" title="{{.Title}}" style="margin-right: 0px;"><label>{{.Title}}</label><i class="fa fa-chevron-right"></i></a>
<a class="nav nav-next" href="{{.RelPermalink}}" title="{{.Title}}" style="margin-right: 0px;"><label>{{.Title}}</label><i class="fa fa-chevron-right"></i></a>
{{- end }}
{{- end -}}
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<script type="text/javascript" src="{{"js/lunr.min.js" | relURL}}"></script>
<script type="text/javascript" src="{{"js/auto-complete.js" | relURL}}"></script>
<script type="text/javascript">
{{ if .Site.IsMultiLingual }}
{{ if hugo.IsMultilingual }}
var baseurl = "{{.Site.BaseURL}}{{.Site.LanguagePrefix}}";
{{ else }}
var baseurl = "{{.Site.BaseURL}}";
Expand Down Expand Up @@ -120,7 +120,7 @@ <h1>{{.Title}}</h1>

{{define "breadcrumb"}}
{{ if .page.Parent}}
{{$value := (printf "<a href='%s'>%s</a> > %s" .page.Parent.URL .page.Parent.Title .value)}}
{{$value := (printf "<a href='%s'>%s</a> > %s" .page.Parent.RelPermalink .page.Parent.Title .value)}}
{{ template "breadcrumb" dict "page" .page.Parent "value" $value }}
{{else}}
{{.value|safeHTML}}
Expand Down
2 changes: 1 addition & 1 deletion docs/themes/docdock/layouts/partials/original/head.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
{{ .Hugo.Generator }}
{{ hugo.Generator }}

<title>{{ .Title }} :: {{ .Site.Title }}</title>
<link rel="shortcut icon" href="{{"images/favicon.png" | relURL}}" type="image/x-icon" />
Expand Down
4 changes: 2 additions & 2 deletions docs/themes/docdock/layouts/shortcodes/children.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@
{{- $numn := add $num $.count }}

{{- (printf "<h%d>" $numn)|safeHTML}}
<a href="{{.URL}}" >{{ .Title }}</a>
<a href="{{.RelPermalink}}" >{{ .Title }}</a>
{{- (printf "</h%d>" $numn)|safeHTML}}
{{- else}}
{{- (printf "<%s>" $.style)|safeHTML}}
<a href="{{.URL}}" >{{ .Title }}</a>
<a href="{{.RelPermalink}}" >{{ .Title }}</a>
{{- (printf "</%s>" $.style)|safeHTML}}
{{- end}}

Expand Down
4 changes: 2 additions & 2 deletions docs/themes/docdock/layouts/shortcodes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
<div><strong>Pages liées</strong></div>
<ul>
{{ range sort .Page.Sections }}
<li><a href="{{.URL}}" >{{ .Title }}</a></li>
<li><a href="{{.RelPermalink}}" >{{ .Title }}</a></li>
{{ end }}
{{ range sort .Page.Pages }}
<li><a href="{{.URL}}" >{{ .Title }}</a></li>
<li><a href="{{.RelPermalink}}" >{{ .Title }}</a></li>
{{ end }}
</ul>
</div>
25 changes: 10 additions & 15 deletions docs/themes/docdock/layouts/shortcodes/revealjs.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<iframe id="slideFrame" src="{{"none.html" | relURL }}" style="width:{{with .Get "width"}}{{.}}{{else}}100%{{end}};height:{{with .Get "height"}}{{.}}{{else}}30em{{end}}; border:0px"></iframe>

<div id="slideContent">
<link rel="stylesheet" href="{{"revealjs/css/reveal.css"|relURL}}">
<link rel="stylesheet" href="{{"revealjs/css/theme/"|relURL}}{{with .Get "theme"}}{{.|safeHTML}}{{else}}league{{end}}.css" id="theme">
<link rel="stylesheet" href="{{"revealjs/lib/css/zenburn.css"|relURL}}">
<link rel="stylesheet" href="{{"revealjs/dist/reveal.css"|relURL}}">
<link rel="stylesheet" href="{{"revealjs/dist/theme/"|relURL}}{{with .Get "theme"}}{{.|safeHTML}}{{else}}league{{end}}.css" id="theme">
<link rel="stylesheet" href="{{"revealjs/dist/plugin/highlight/zenburn.css"|relURL}}">

<div class="reveal">
<div class="slides">
Expand All @@ -17,8 +17,11 @@
</div>
</div>

<script async src="{{"/revealjs/lib/js/head.min.js"|relURL}}"></script>
<script async src="{{"/revealjs/js/reveal.js"|relURL}}"></script>
<script src="{{"/revealjs/dist/reveal.js"|relURL}}"></script>
<script src="{{"/revealjs/dist/plugin/markdown.js"|relURL}}"></script>
<script src="{{"/revealjs/dist/plugin/highlight.js"|relURL}}"></script>
<script src="{{"/revealjs/dist/plugin/zoom.js"|relURL}}"></script>
<script src="{{"/revealjs/dist/plugin/notes.js"|relURL}}"></script>
<script>
function initSlides() {
Reveal.initialize({
Expand All @@ -30,16 +33,8 @@
progress: {{with .Get "progress"}}{{.|safeHTML}}{{else}}false{{end}} ,
transition: {{with .Get "transition"}}{{.}}{{else}}"concave"{{end}},

// theme: Reveal.getQueryHash().theme, // available themes are in /css/theme
// Optional libraries used to extend on reveal.js
dependencies: [
{ src: '{{"revealjs/lib/js/classList.js"|relURL}}"', condition: function() { return !document.body.classList; } },
{ src: '{{"revealjs/plugin/markdown/marked.js"|relURL}}', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: '{{"revealjs/plugin/markdown/markdown.js"|relURL}}', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: '{{"revealjs/plugin/highlight/highlight.js"|relURL}}', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },
{ src: '{{"revealjs/plugin/zoom-js/zoom.js"|relURL}}', async: true, condition: function() { return !!document.body.classList; } },
{ src: '{{"revealjs/plugin/notes/notes.js"|relURL}}', async: true, condition: function() { return !!document.body.classList; } }
]
// Plugins for Reveal.js 6.0
plugins: [ RevealMarkdown, RevealHighlight, RevealZoom, RevealNotes ]
});
}
</script>
Expand Down
8 changes: 8 additions & 0 deletions docs/themes/docdock/static/revealjs/.codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git*,node_modules,package-lock.json,*.css,.codespellrc,react
check-hidden = true
# Ignore super long lines -- must be minimized etc, acronyms
# and some near hit variables
ignore-regex = ^.{120,}|\b(currentY|FOM)\b
# ignore-words-list =
13 changes: 0 additions & 13 deletions docs/themes/docdock/static/revealjs/.gitignore
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,13 +0,0 @@
.idea/
*.iml
*.iws
*.eml
out/
.DS_Store
.svn
log/*.log
tmp/**
node_modules/
.sass-cache
css/reveal.min.css
js/reveal.min.js
7 changes: 7 additions & 0 deletions docs/themes/docdock/static/revealjs/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
js/**/*.js
plugin/**/*.js
**/*.md
test/**/*.html
examples/**/*.md
dist/**/*
*.html
8 changes: 8 additions & 0 deletions docs/themes/docdock/static/revealjs/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"useTabs": true,
"tabWidth": 2,
"trailingComma": "es5",
"printWidth": 100,
"singleQuote": true,
"bracketSameLine": false
}
5 changes: 0 additions & 5 deletions docs/themes/docdock/static/revealjs/.travis.yml

This file was deleted.

23 changes: 0 additions & 23 deletions docs/themes/docdock/static/revealjs/CONTRIBUTING.md

This file was deleted.

Loading