You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update applications-dashboard.md
* Add new pull request title variables
Added descriptions of new pull request title variables - escaped and unescaped
Copy file name to clipboardExpand all lines: _docs/pipelines/variables.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,9 +128,11 @@ The table below describes the system variables.
128
128
| {% raw %}`${{CF_BUILD_INITIATOR}}`{% endraw %} | The username of the user who initiated the build.<br> If the build is initiated by a Git webhook, as for example from a PR, this variable returns the webhook user.<br>If the build is restarted manually, the variable always returns the username of the person who restarted the build. |
129
129
| {% raw %}`${{CF_ACCOUNT}}`{% endraw %} | The Codefresh account for this build. |
130
130
| {% raw %}`${{CF_COMMIT_URL}}`{% endraw %} | The commit URL. |
131
-
| {% raw %}`${{CF_COMMIT_MESSAGE}}`{% endraw %} | The commit message of the Git repository revision, at the time of execution.<br/> The messages quotes are escaped (i.e. ' is not \', " is now \"). |
132
-
| {% raw %}`${{CF_COMMIT_MESSAGE_ESCAPED}}`{% endraw %} | The commit message of the Git repository revision, at the time of execution.<br/> Special characters are escaped. |
133
-
| {% raw %}`"${{CF_REVISION}}"`{% endraw %} | The revision of the Git repository of the main pipeline, at the time of execution. <br/> To get the abbreviated 7-character revision hash as used in Git, use {% raw %}`${{CF_SHORT_REVISION}}`{% endraw %}. <br>**NOTE**: To tag the image as a string with quotes, use {% raw %}`${{CF_SHORT_REVISION}}`{% endraw %} . |
131
+
| {% raw %}`${{CF_COMMIT_MESSAGE}}`{% endraw %} | The commit message of the Git repository revision at the time of execution.<br/> Only quotes in the message are escaped (`'` is escaped `\'` and `"` is escaped as `\"`).<br>To get the title of the pull request, use {% raw %}`${{CF_PULL_REQUEST_TITLE}}`{% endraw %}. |
132
+
| {% raw %}`${{CF_COMMIT_MESSAGE_ESCAPED}}`{% endraw %} | The commit message of the Git repository revision at the time of execution with special characters _escaped_. <br> To get the escaped title of the pull request, use {% raw %}`${{CF_PULL_REQUEST_TITLE_ESCAPED}}`{% endraw %}. |
133
+
| {% raw %}`${{CF_PULL_REQUEST_TITLE}}`{% endraw %} | The _unescaped_ title of the pull request that triggered the pipeline build.<br/> To escape special characters, use {% raw %}`${{CF_PULL_REQUEST_TITLE_ESCAPED}}`{% endraw %}. |
134
+
| {% raw %}`${{CF_PULL_REQUEST_TITLE_ESCAPED}}`{% endraw %} | The title of the pull request that triggered the pipeline build, with special characters _escaped_. <br>To not escape special characters, use {% raw %}`${{CF_PULL_REQUEST_TITLE}}`{% endraw %}. |
135
+
| {% raw %}`${{CF_REVISION}}`{% endraw %} | The revision of the Git repository of the main pipeline, at the time of execution. <br/> To get the abbreviated 7-character revision hash as used in Git, use {% raw %}`${{CF_SHORT_REVISION}}`{% endraw %}. <br>**NOTE**: To tag the image as a string with quotes, use {% raw %}`${{CF_SHORT_REVISION}}`{% endraw %} . |
134
136
| {% raw %}`${{CF_VOLUME_NAME}}`{% endraw %} | The [shared volume]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/#sharing-the-workspace-between-build-steps) defined in [compositions]({{site.baseurl}}/docs/pipelines/steps/composition/). |
135
137
| {% raw %}`${{CF_VOLUME_PATH}}`{% endraw %} | The mounted path of the [shared volume]({{site.baseurl}}/docs/pipelines/introduction-to-codefresh-pipelines/#sharing-the-workspace-between-build-steps) within a freestyle container. In the current implementation it expands to `/codefresh/volume`. |
136
138
| {% raw %}`${{CF_BUILD_TRIGGER}}`{% endraw %} | The indication of how the current build was triggered:{::nomarkdown} <ul><li><code class="highlighter-rouge">build</code>: The build was triggered by clicking the Build button</li><li><code class="highlighter-rouge">webhook</code>: The build was triggered from a control version webhook.</ul>{:/} |
0 commit comments