codefresh 0.78.2

package/docs/content/_index.md

@@ -0,0 +1,19 @@
++++
+description = "Codefresh CLI"
+date = "2017-04-24T18:36:24+02:00"
+weight = 1
++++
+
+# Codefresh CLI
+
+Welcome to Codefresh official CLI documentation!
+
+The Codefresh CLI provides a full and flexible interface to interact with Codefresh.<br>
+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>
+
+To get started please navigate to the [Getting started](getting-started) page.

package/docs/content/contexts/spec/_index.md

@@ -0,0 +1,28 @@
++++
+title = "Spec"
++++
+
+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>
+
+### 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>
+
+### Data
+`.spec.data` should be different according to the type of the context
+
+
+

package/docs/content/contexts/spec/config.md

@@ -0,0 +1,30 @@
++++
+title = "Config"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 10
++++
+
+Config context stores a set of keys and values.
+
+### Type
+`.spec.type` should be `config`.
+
+### Data
+`.spec.data` should be an array of keys and values.
+
+### Examples
+
+#### config with two keys
+```yaml
+apiVersion: "v1"
+kind: "context"
+owner: "account"
+metadata:
+  name: "my-config-context"
+spec:
+  type: "config"
+  data:
+    dbUrl: "db-url"
+    sysUrl: "sys-url"
+```

package/docs/content/contexts/spec/helm-repository.md

@@ -0,0 +1,16 @@
++++
+title = "Helm Repository"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 50
++++
+
+Helm-Repository context stores an integration with a helm repository.
+
+### Type
+`.spec.type` should be `helm-repository`.
+
+### Data
+`.spec.data` should be an array of keys and values.
+
+### Examples

package/docs/content/contexts/spec/secret-yaml.md

@@ -0,0 +1,32 @@
++++
+title = "Secret Yaml"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 40
++++
+
+Secret-Yaml context stores an yaml file encrypted.
+
+### Type
+`.spec.type` should be `secret-yaml`.
+
+### Data
+`.spec.data` should be an array of keys and values.
+
+### Examples
+
+#### secret-yaml with two keys
+```yaml
+apiVersion: "v1"
+kind: "context"
+owner: "account"
+metadata:
+  name: "my-secret-yaml-context"
+spec:
+  type: "secret-yaml"
+  data:
+    serviceType: "LoadBalancer"
+    image: "mongo"
+    type: 
+      - "encrypted"
+```

package/docs/content/contexts/spec/secret.md

@@ -0,0 +1,30 @@
++++
+title = "Secret"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 20
++++
+
+Secret context stores a set of keys and values encrypted.
+
+### Type
+`.spec.type` should be `secret`.
+
+### Data
+`.spec.data` should be an array of keys and values.
+
+### Examples
+
+#### secret with two keys
+```yaml
+apiVersion: "v1"
+kind: "context"
+owner: "account"
+metadata:
+  name: "my-secret-context"
+spec:
+  type: "secret"
+  data:
+    dbPassword: "secret-db-password"
+    adminPassword: "secret-admin-password"
+```

package/docs/content/contexts/spec/yaml.md

@@ -0,0 +1,30 @@
++++
+title = "Yaml"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 30
++++
+
+Yaml context stores an yaml file.
+
+### Type
+`.spec.type` should be `yaml`.
+
+### Data
+`.spec.data` should be an array of keys and values.
+
+### Examples
+
+#### yaml with two keys
+```yaml
+apiVersion: "v1"
+kind: "context"
+owner: "account"
+metadata:
+  name: "my-yaml-context"
+spec:
+  type: "yaml"
+  data:
+    serviceType: "LoadBalancer"
+    image: "mongo"
+```

package/docs/content/external-resources.md

@@ -0,0 +1,8 @@
++++
+title = "External Resources"
+description = "Hugo-built Sites with docdock theme"
++++
+
+
+#### [https://codefresh.io/blog/introducing-codefresh-cli/](https://codefresh.io/blog/introducing-codefresh-cli/)  by Dan Garfield
+![https://invincible.site/](https://codefresh.io/wp-content/uploads/2017/11/blog-side-3.png)

package/docs/content/getting-started/_index.md

@@ -0,0 +1,28 @@
++++
+title = "Getting Started"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 10
++++
+
+## Install
+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 />
+
+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}`
+
+## Getting Help
+To get help and usage instructions run `codefresh [COMMAND]--help`.<br />
+A help message will appear in the terminal.<br />
+
+## Showing Current Version
+Run `codefresh version` to see the current CLI version.
+
+<br />
+#### That's it, you are good to go!

package/docs/content/installation/_index.md

@@ -0,0 +1,13 @@
++++
+title = "Installation"
+description = ""
+weight = 20
++++
+
+Codefresh CLI is developed and built with node.js. <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.<br>
+
+If you don't have node.js installed you can install the CLI by [Downloading](/cli/installation/download) it directly.<br />
+
+It is also possible to run the CLI using a [Docker image](/cli/installation/docker).

package/docs/content/installation/docker.md

@@ -0,0 +1,15 @@
++++
+title = "Docker Image"
+description = "asdsd"
+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>
+
+Pull the latest version: 
+`docker pull codefresh/cli`
+
+Pull a specific version:
+`docker pull codefresh/cli:${VERSION}`
+

package/docs/content/installation/homebrew.md

@@ -0,0 +1,29 @@
++++
+title = "HOMEBREW"
+description = "Homebrew install"
+date = "2018-01-30T12:00:00+02:00"
+weight = 60
++++
+
+Install Codefresh CLI on macOS with [Homebrew](https://brew.sh).
+
+## Install
+
+```sh
+# tap Codefresh homebrew repo
+brew tap codefresh-io/cli
+# install Codefresh CLI
+brew install codefresh
+```
+
+## Update to the latest version
+
+```sh
+brew upgrade codefresh
+```
+
+## Uninstall
+
+```sh
+brew uninstall codefresh
+```

package/docs/content/installation/npm.md

@@ -0,0 +1,22 @@
++++
+title = "NPM"
+description = "asd"
+date = "2017-04-24T18:36:24+02:00"
+weight = 10
++++
+
+{{% alert theme="warning" %}}the CLI requires node version 8.0.0 or higher{{% /alert %}}
+
+Codefresh's CLI is available for installation through NPM registry.
+
+Install:
+`npm install -g codefresh`
+
+Install a specific version:
+`npm install -g codefresh@{VERSION}`
+
+Update to latest version:
+`npm install -g codefresh`
+
+Update to a specific version:
+`npm install -g codefresh@${VERSION}`

package/docs/content/installation/yarn.md

@@ -0,0 +1,22 @@
++++
+title = "YARN"
+description = "asd"
+date = "2017-04-24T18:36:24+02:00"
+weight = 20
++++
+
+{{% alert theme="warning" %}}the CLI requires node version 8.0.0 or higher{{% /alert %}}
+
+Codefresh's CLI is available for installation using YARN.
+
+Install:
+`yarn global add codefresh`
+
+Install a specific version:
+`yarn global add codefresh@{VERSION}`
+
+Update to latest version:
+`yarn global upgrade codefresh`
+
+Update to a specific version:
+`yarn global upgrade codefresh@{VERSION}`

package/docs/content/more/_index.md

@@ -0,0 +1,7 @@
++++
+title = "More..."
+weight = 130
++++
+
+
+{{COMMANDS}}

package/docs/content/operate on resources/_index.md

@@ -0,0 +1,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>
+Check each specific resource `spec` for its documentation
+
+{{COMMANDS}}

package/docs/content/pipelines/Run Pipeline.md

@@ -0,0 +1,38 @@
+{{HEADER}}
+
+{{DESCRIPTION}}
+
+{{COMMANDS}} 
+
+{{ARGUMENTS}}
+
+{{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>
+The pipeline will be triggered multiple times according to the array length.
+
+#### Variable yaml file with 2 sets of variables
+```yaml
+- key: value
+  key2: key1
+- key: value
+  key2: key2
+```
+
+#### Variable json file with 2 sets of variables
+```json
+[
+  {
+    "key": "value",
+    "key2": "key1"
+  },
+  {
+    "key": "value",
+    "key2": "key2"
+  }
+]
+```
+
+{{EXAMPLES}}

package/docs/content/pipelines/spec.md

@@ -0,0 +1,190 @@
++++
+title = "Spec"
++++
+
+A Pipeline needs `.version`, `.kind`, and `.metadata` fields.
+
+A Pipeline also needs a `.spec` section.
+
+### Examples
+
+#### Basic Pipeline with implicit clone step (will checkout connected repo automatically)
+
+```yaml
+version: '1.0'
+kind: pipeline
+metadata:
+  name: codefresh-io/cli/default-pipeline
+  labels:
+    tags: []
+  deprecate:
+    applicationPort: '8080'
+    repoPipeline: true
+spec:
+  triggers:
+    - type: git
+      repo: codefresh-io/cli
+      events:
+        - push.heads
+      pullRequestAllowForkEvents: false
+      commentRegex: /.*/gi
+      branchRegex: /.*/gi
+      branchRegexInput: regex
+      provider: github
+  contexts: []
+  variables:
+    - key: PORT
+      value: '3000'
+    - key: SECRET
+      value: 'secret-value'
+      encrypted: true
+  steps:
+    test_step_1:
+      image: alpine
+      working_directory: '${{clone_step}}'
+      commands:
+        - echo ls
+        - echo "hello world"
+        - echo "plain value $PORT"
+        - echo "encrypted value $PAPA"
+        - echo "value from context $COOKIE"
+    build:
+      type: build
+      working_directory: '${{clone_step}}'
+      dockerfile: ./Dockerfile
+      image_name: my-custom-docker-image
+      tag: foo
+  stages: []
+```
+
+#### Basic Pipeline with explicit clone step
+
+```yaml
+version: '1.0'
+kind: pipeline
+metadata:
+  name: codefresh-io/cli/basic-pipeline
+  labels:
+    tags: []
+  deprecate:
+    applicationPort: '8080'
+    repoPipeline: true
+spec:
+  triggers:
+    - type: git
+      repo: codefresh-io/cli
+      events:
+        - push.heads
+      pullRequestAllowForkEvents: false
+      commentRegex: /.*/gi
+      branchRegex: /.*/gi
+      branchRegexInput: regex
+      provider: github
+  contexts: []
+  variables:
+    - key: PORT
+      value: '3000'
+    - key: SECRET
+      value: 'secret-value'
+      encrypted: true
+  steps:
+    clone_step:
+      repo: codefresh-contrib/python-flask-sample-app
+      revision: master
+      type: git-clone
+      git: CF-default
+    test_step_1:
+      image: alpine
+      working_directory: '${{clone_step}}'
+      commands:
+        - echo ls
+        - echo "hello world"
+        - echo "plain value $PORT"
+        - echo "encrypted value $PAPA"
+        - echo "value from context $COOKIE"
+    build:
+      type: build
+      working_directory: '${{clone_step}}'
+      dockerfile: ./Dockerfile
+      image_name: my-custom-docker-image
+      tag: bla
+  stages: []
+```
+
+#### Pipeline with a remote spec template brought from a git repository
+```yaml
+version: '1.0'
+kind: pipeline
+metadata:
+  name: codefresh-io/cli/from-repo
+  isPublic: false
+  labels:
+    tags: []
+  deprecate:
+    applicationPort: '8080'
+    repoPipeline: true
+spec:
+  triggers:
+    - type: git
+      repo: codefresh-io/cli
+      events:
+        - push.heads
+      pullRequestAllowForkEvents: false
+      commentRegex: /.*/gi
+      branchRegex: /.*/gi
+      branchRegexInput: regex
+      provider: github
+  contexts: []
+  variables:
+    - key: PORT
+      value: '3000'
+    - key: SECRET
+      value: 'secret-value'
+      encrypted: true
+  specTemplate:
+    location: git
+    context: git-context-name # if not specified will use the default git-context
+    repo: codefresh-io/cli
+    path: codefresh.yml
+    revision: master # can be a branch or commit. if not specified will use CF_BRANCH variable value
+  steps: {}
+  stages: []
+```
+
+#### Pipeline with a remote spec template from a public git URL
+```yaml
+version: '1.0'
+kind: pipeline
+metadata:
+  name: codefresh-io/cli/from-external
+  isPublic: false
+  labels:
+    tags: []
+  deprecate:
+    applicationPort: '8080'
+    repoPipeline: true
+  project: codefresh-io/cli
+spec:
+  triggers:
+    - type: git
+      repo: codefresh-io/cli
+      events:
+        - push.heads
+      pullRequestAllowForkEvents: false
+      commentRegex: /.*/gi
+      branchRegex: /.*/gi
+      branchRegexInput: regex
+      provider: github
+  contexts: []
+  variables:
+    - key: PORT
+      value: '3000'
+    - key: SECRET
+      value: 'secret-value'
+      encrypted: true
+  specTemplate:
+    location: url
+    url: 'https://raw.githubusercontent.com/codefresh-io/cli/master/codefresh.yml'
+  steps: {}
+  stages: []
+```

package/docs/docs.spec.js

@@ -0,0 +1,8 @@
+const docs = require('../docs');
+
+describe('docs generation', () => {
+    jest.setTimeout(20000);
+    it('should generate docs', async () => {
+        return await docs();
+    });
+});