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

# instana/pipeline-feedback

Create Instana Pipeline Feedback releases from your CircleCI workflows.


## Commands

### create_release

Create a new Pipeline Feedback release in Instana.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_token` | env_var_name | INSTANA_API_TOKEN | The name of the environment variable that contains a valid API token with the "Configuration of releases" permissions.
 |
| `endpoint` | env_var_name | INSTANA_ENDPOINT_URL | The name of the environment variable that contains the URL of your Instana tenant unit, e.g.: https://apm-awesome.instana.io. For self-managed (a.k.a., on-premise) setups, you can also add the port to use, e.g.: https://instana.awesome.com:1444.
 |
| `release_name` | string |  | The name of this release in Instana. |
| `release_scope` | string | {} | JSON-encoded scoping information for the release. The usage of environment variables is supported. Example: ```json
  {
    "services": [
      {"name": "${CIRCLE_PROJECT_REPONAME}.${ENV}"}
    ]
  }
``` If not provided, the release will be marked as global to your tenant unit.
 |

## Jobs

### create_release

Create a new Pipeline Feedback release in Instana.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_token` | env_var_name | INSTANA_API_TOKEN | The name of the environment variable that contains a valid API token with the "Configuration of releases" permissions.
 |
| `endpoint` | env_var_name | INSTANA_ENDPOINT_URL | The name of the environment variable that contains the URL of your Instana tenant unit, e.g.: https://apm-awesome.instana.io. For self-managed (a.k.a. on-premise) setups, you can also add the port to use, e.g.: https://instana.awesome.com:1444.
 |
| `executor_image` | string | icr.io/instana/pipeline-feedback-orb-executor:latest |  |
| `release_name` | string |  | The name of this release in Instana. |
| `release_scope` | string | {} | JSON-encoded scoping information for the release. If not provided, the release will be marked as global to your tenant unit. |

## Examples

### create_release

The sample usage of the Instana Pipeline Feedback CircleCI Orb shows a workflow that includes the build and release of an application. Before the release is performed, data about the upcoming release is submitted to Instana, including CircleCI data like the build identifier and build number in the release name to be displayed in Instana. In the example, the release in Instana is scoped to the `My Awesome App` Application Perspective and, additionally, two services, `Cool service #1` and `Cool service #2`.


```yaml
version: '2.1'
orbs:
  pipeline-feedback: instana/pipeline-feedback@2.0.1
jobs:
  build_payment_service:
    docker:
      - image: cimg/node:lts
    steps:
      - run: echo Build
  release_payment_service:
    docker:
      - image: icr.io/instana/pipeline-feedback-orb-executor:latest
    steps:
      - pipeline-feedback/create_release:
          release_name: 'My Awesome App release (CircleCI: ${CIRCLE_JOB}/${CIRCLE_BUILD_NUM})'
          release_scope: |
            {
              "applications": [
                { "name": "My Awesome App" }
              ],
              "services": [
                { "name": "Cool service #1" },
                { "name": "${CIRCLE_PROJECT_REPONAME}" },
                { "name": "${CIRCLE_PROJECT_REPONAME}.production" },
                { "name": "${CIRCLE_PROJECT_REPONAME}.staging" },
                { "name": "${CIRCLE_PROJECT_REPONAME}.dev" },
                {
                  "name": "Cool service #2",
                  "scopedTo": {
                    "applications": [
                      { "name": "My Cool App" }
                    ]
                  }
                }
              ]
            }
      - run: echo "Do a lot of release"
workflows:
  build_and_release_payment_service:
    jobs:
      - build_payment_service
      - release_payment_service:
          requires:
            - build_payment_service
```