> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# gimlet-io/circleci-orb

The Gimlet CircleCI Orb makes Gimlet Artifact pushing a oneliner.


## Commands

### gimlet-artifact-create

Command to create a Gimlet build artifact for release automation

| Parameter | Type | Default | Description |
|---|---|---|---|
| `app` | string |  | If deploy is set to true, the step will deploy the defined app to the defined env |
| `debug` | string | false | If set to true, the step will print the artifact then exit. Will not call the Gimlet API. |
| `deploy` | string | false | If set to true, the step will deploy the defined app to the defined env |
| `env` | string |  | If deploy is set to true, the step will deploy the defined app to the defined env |
| `timeout` | string | 10m |  |
| `wait` | string | false | If set to true, the step will wait until the action is finished or timed out |

## Jobs

### gimlet-artifact-push

"Job to create and push a Gimlet build artifact for release automation"


| Parameter | Type | Default | Description |
|---|---|---|---|
| `app` | string |  | If deploy is set to true, the step will deploy the defined app to the defined env |
| `debug` | string | false | If set to true, the step will print the artifact then exit. Will not call the Gimlet API. |
| `deploy` | string | false | If set to true, the step will deploy the defined app to the defined env |
| `env` | string |  | If deploy is set to true, the step will deploy the defined app to the defined env |
| `timeout` | string | 10m |  |
| `wait` | string | false | If set to true, the step will wait until the action is finished or timed out |

## Executors

### docker

## Examples

### example

How to publish a Gimlet Artifact


```yaml
version: '2.1'
orbs:
  gimlet: gimlet-io/circleci-orb@1.2.3
workflows:
  my-workflow:
    jobs:
      - build_docker_image:
          machine: true
          steps:
            - attach_workspace:
                at: /tmp/workspace
            - docker-build:
                service-name: my-service
            - gimlet/gimlet-artifact-create:
                image-tag: my-image-registry/my-service:$CIRCLE_SHA1
          working_directory: /tmp/workspace
```