Skip to content

Commit fce3421

Browse files
committed
Remove reference to CIRCLE_COMPARE_URL as a built in env var.
CIRCLE_COMPARE_URL has been hard coded to the empty string since 2018 and has good of references online wrt the alternatives. (https://discuss.circleci.com/t/is-circle-compare-url-still-a-thing/33366) We include the above advice elsewhere in our documentation wrt using pipeline values as an alternative is still valid (part of https://circleci.atlassian.net/browse/TASKS-855)
1 parent 1efceea commit fce3421

File tree

5 files changed

+0
-18
lines changed

5 files changed

+0
-18
lines changed

jekyll/_cci2/build-processing.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,6 @@ The following features are available for use in your pipelines:
3030

3131
When migrating from a server v2.x to a v3.x installation you will have project configurations made before the introduction of pipelines. Pipelines are automatically enabled for server v3.x installations so all you need to do is change your project configurations (`.circleci/_config.yml`) to `version: 2.1` to access all the features described in the section above.
3232

33-
### Pipelines with 2.0 configuration
34-
{: #pipelines-with-20-configuration }
35-
{:.no_toc}
36-
37-
When using CircleCI cloud or server v3.x the CircleCI pipelines engine is automatically enabled. If, for whatever reason, you continue to use a 2.0 config, CircleCI will inject the `CIRCLE_COMPARE_URL` environment variable into all jobs for backwards compatibility.
38-
39-
This environment variable is generated in a different way compared to the version available in legacy jobs, and is not always available – it is not injected when there is no meaningful previous revision, for example, on the first push of commits to an empty repository, or when a new branch is created/pushed without any additional commits.
40-
4133
## See also
4234
{: #see-also }
4335
{:.no_toc}

jekyll/_includes/snippets/built-in-env-vars.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,4 @@ Variable | Type | Value
2626
`CIRCLE_WORKFLOW_WORKSPACE_ID`{:.env_var} | String | An identifier for the [workspace]({{site.baseurl}}/2.0/glossary/#workspace) of the current job. This identifier is the same for every job in a given workflow.
2727
`CIRCLE_WORKING_DIRECTORY`{:.env_var} | String | The value of the `working_directory` key of the current job.
2828
`CIRCLE_INTERNAL_TASK_DATA`{:.env_var} | String | **Internal**. A directory where internal data related to the job is stored. We do not document the contents of this directory; the data schema is subject to change.
29-
`CIRCLE_COMPARE_URL`{:.env_var} | String | **Deprecated**. The GitHub or Bitbucket URL to compare commits of a build. Available in config v2 and below. For v2.1 we will introduce ["pipeline values"]({{site.baseurl}}/2.0/pipeline-variables/) as an alternative.
3029
{: class="table table-striped"}

jekyll/_includes/snippets/ja/built-in-env-vars.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,4 @@
2626
| `CIRCLE_WORKFLOW_WORKSPACE_ID`{:.env_var} | 文字列型 | 現在のジョブの[ワークスペース]({{site.baseurl}}/2.0/glossary/#workspace)の識別子。 この識別子は、特定のワークスペース内のすべてのジョブで同じです。 |
2727
| `CIRCLE_WORKING_DIRECTORY`{:.env_var} | 文字列型 | 現在のジョブの `working_directory` キーの値。 |
2828
| `CIRCLE_INTERNAL_TASK_DATA`{:.env_var} | 文字列型 | **内部用**。 ジョブ関連の内部データが格納されるディレクトリ。 データ スキーマは変更される可能性があるため、このディレクトリのコンテンツは文書化されていません。 |
29-
| `CIRCLE_COMPARE_URL`{:.env_var} | 文字列型 | **非推奨**。 同じビルドのコミットどうしを比較するための GitHub または Bitbucket URL。 v2 以下の設定ファイルで使用可能です。 v2.1 では、この変数に代わり "[パイプライン値]({{site.baseurl}}/2.0/pipeline-variables/)" が導入されています。 |
3029
{: class="table table-striped"}

jekyll/archived/_archive/environment-variables.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,6 @@ The SHA1 of the commit being tested.
5353

5454
A link to the homepage for the current repository, for example, `https://github.com/circleci/frontend`.
5555

56-
`CIRCLE_COMPARE_URL`
57-
58-
A link to GitHub's comparison view for this push. Not present for builds that are triggered by GitHub pushes.
59-
6056
`CIRCLE_BUILD_URL`
6157

6258
A permanent link to the current build, for example, `https://circleci.com/gh/circleci/frontend/933`.

jekyll/archived/_cci1/environment-variables.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,6 @@ The SHA1 of the commit being tested.
5353

5454
A link to the homepage for the current repository, for example, `https://github.com/circleci/frontend`.
5555

56-
`CIRCLE_COMPARE_URL`
57-
58-
A link to GitHub's comparison view for this push. Not present for builds that are triggered by GitHub pushes.
59-
6056
`CIRCLE_BUILD_URL`
6157

6258
A permanent link to the current build, for example, `https://circleci.com/gh/circleci/frontend/933`.

0 commit comments

Comments
 (0)