Merge pull request #15 from atlassian-labs/sbland2-update-readme

Update orb formatting

Author: sbland2

.circleci/config.yml

@@ -16,6 +16,7 @@ workflows:
             tags:
               only: /.*/
       - orb-tools/review:
+          exclude: RC008
           filters:
             tags:
               only: /.*/

Readme.md

@@ -2,7 +2,7 @@
 
 [![CircleCI Build Status](https://circleci.com/gh/atlassian-labs/Compass-Orb.svg?style=shield 'CircleCI Build Status')](https://circleci.com/gh/atlassian-labs/Compass-Orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/atlassian-labs/compass.svg)](https://circleci.com/orbs/registry/orb/atlassian-labs/compass) [![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
 
-An orb for reporting the status of CircleCI builds and deployments to Atlassian Compass
+An orb for reporting the status of CircleCI builds and deployments to Atlassian Compass.
 
 ## Usage
 

src/commands/notify_deployment.yml

@@ -51,12 +51,11 @@ steps:
   - run:
       name: COMPASS - Set Environment Name
       # `environment` is by default a variable name `${CIRCLE_JOB}`
-      # but unlike parameters, variables are not interpolated in config.yml 
+      # but unlike parameters, variables are not interpolated in config.yml
       # they must evaluate inside the container as part of a step
-      command: |
-        echo 'export ENVIRONMENT_NAME="<<parameters.environment>>"' >> $BASH_ENV
-        source $BASH_ENV
-        echo "Using displayName: $ENVIRONMENT_NAME"
+      environment:
+        ENVIRONMENT_NAME: <<parameters.environment>>
+      command: <<include(scripts/set_environment_name.sh)>>
       when: always
   - run:
       name: Update status in Atlassian Compass

src/scripts/set_environment_name.sh

@@ -0,0 +1,3 @@
+ echo "export ENVIRONMENT_NAME=${ENVIRONMENT_NAME}" >> $BASH_ENV
+    source $BASH_ENV
+    echo "Using displayName: $ENVIRONMENT_NAME"