Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
autify-cli: autify/autify-cli@2.1.0
Use autify-cli
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Install Autify Command Line Interface (CLI).
1
2
3
4
5
6
7
8
9
10
11
12
13
version: '2.1'
orbs:
autify-cli: autify/autify-cli@2
jobs:
autify-cli-example:
executor: autify-cli/default
steps:
- autify-cli/install
- run: autify --version
workflows:
autify-cli:
jobs:
- autify-cli-example
Install Autify Command Line Interface (CLI).
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
shell-installer-url | Install version | No | >- https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-cicd.bash | string |
A base Docker image should work.
PARAMETER | DESCRIPTION | REQUIRED | DEFAULT | TYPE |
---|---|---|---|---|
size | Dokcer executer's resource_class | No | small | string |
tag | Pick a specific cimg/base image variant: https://hub.docker.com/r/cimg/base/tags
| No | current | string |
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: |
Install Autify Command Line Interface (CLI) to communicate with Autify. Currently, Windows machine isn't supported.
display:
home_url: https://help.autify.com/docs/autify-command-line-interface
source_url: https://github.com/autifyhq/autify-circleci-orb-cli
commands:
install:
description: |
Install Autify Command Line Interface (CLI).
parameters:
shell-installer-url:
default: https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-cicd.bash
description: Install version
type: string
steps:
- run:
command: |
#!/bin/bash
set -xe
: "${PARAM_SHELL_INSTALLER_URL:?"Provide the installer URL"}"
cd "${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}"
export AUTIFY_CLI_INSTALL_USE_CACHE=1
curl -L "$PARAM_SHELL_INSTALLER_URL" | bash -xe
while IFS= read -r line; do
echo "export PATH=$line:\$PATH" >> "$BASH_ENV"
done < "./autify/path"
environment:
PARAM_SHELL_INSTALLER_URL: <<parameters.shell-installer-url>>
name: Install Autify CLI
shell: bash -xe
executors:
default:
description: |
A base Docker image should work.
docker:
- image: cimg/base:<<parameters.tag>>
parameters:
size:
default: small
description: Dokcer executer's resource_class
type: string
tag:
default: current
description: |
Pick a specific cimg/base image variant: https://hub.docker.com/r/cimg/base/tags
type: string
resource_class: <<parameters.size>>
examples:
install-autify-cli:
description: |
Install Autify Command Line Interface (CLI).
usage:
version: "2.1"
orbs:
autify-cli: autify/autify-cli@2
jobs:
autify-cli-example:
executor: autify-cli/default
steps:
- autify-cli/install
- run: autify --version
workflows:
autify-cli:
jobs:
- autify-cli-example