From af99765270a1b5834ed32a8e0b4cc0dc63ed9c98 Mon Sep 17 00:00:00 2001 From: Alfredo Lopez Date: Mon, 19 Aug 2019 22:58:50 -0400 Subject: [PATCH] Updated README macros --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 166bf2e..c475acc 100644 --- a/README.md +++ b/README.md @@ -71,15 +71,16 @@ There are 3 required fields: `baseUrl`, `ci`, and `type`. Lightkeeper is a budge | Macro | Details | | ---- | ------ | | `{pr_number}` | The Pull Request Number. | - | `{repo}` | A slugified repo name. | - | `{branch}` | A slugified branch name. | + | `{repo}` | A _slugified_ repo name. | + | `{branch}` | A _slugified_ branch name. | | `{commit_hash}` | The full commit SHA. | | `{commit_hash:n}` | A trimmed SHA, where `n` is a digit. | | *`{target_url}` | The target url from the Github Response. | | **`{environment_url}` | The url from the Deployment status. | \* Available for statuses and deployments. - \** Available for deployments. + + \** Available for deployments only. - Replace `ci` and `type` for your CI tool. Examples: