Skip to content

Commit 8264bc9

Browse files
Remove content on using auto detected deploy markers (#9442)
* remove content on using auto detected deploy markers * formatting
1 parent cdc166a commit 8264bc9

File tree

3 files changed

+13
-64
lines changed

3 files changed

+13
-64
lines changed

jekyll/_cci2/deploy/configure-deploy-markers.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,9 @@ contentTags:
1212

1313
This tutorial shows how to add a deploy marker step to your workflow config. Deploy markers allow you to log all new deployments in one place, update their status and link back to the CI/CD pipelines that triggered them.
1414

15-
Unless you opt out of the feature, CircleCI autodetects potential deployments and creates deploy markers for you.
16-
17-
This guide is for you if you would rather create deploy markers yourself. For more information see the xref:deploys-overview#[Deploys overview] page.
18-
1915
== Introduction
2016

21-
Autodetected or manually configured deploy markers provide a lightweight way to log your deployments without requiring a you to install the CircleCI release agent. If you install deploy markers manually, as described in this guide you will also be able to use the xref:set-up-rollbacks#[CircleCI rollback feature].
17+
Deploy markers provide a lightweight way to log your deployments without requiring a you to install the CircleCI release agent. If you install deploy markers, as described in this guide, you will also be able to use the xref:set-up-rollbacks#[CircleCI rollback feature].
2218

2319
For a full guide to CircleCI's deploys features and functionality, refer to the xref:set-up-circleci-deploys#[Set up CircleCI deploys] guide.
2420

jekyll/_cci2/deploy/deploys-overview.adoc

Lines changed: 11 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -294,75 +294,28 @@ The following table shows a complete list of labels and annotations either requi
294294
|No. Only set if you want to disable the cancel deployment feature for your component.
295295
|===
296296

297-
== Automatic deployment detection and deploy markers
297+
== Deploy markers
298298

299-
CircleCI automatically generates deploy markers for your deployment pipelines. Deploy markers provide a lightweight way to log your deployments without requiring a full CircleCI deploys setup. Deploy markers generate a log of all deployments in one place, for a clear overview of what has changed, without the need to search through your CI/CD pipelines. Deploy markers log all new deployments in one place and link back to the CI/CD pipelines that caused them. You can use deploy markers independently, without installing the CircleCI release agent.
299+
Deploy markers provide a lightweight way to log your deployments without requiring a full CircleCI deploys setup. Deploy markers generate a log of all deployments in one place, for a clear overview of what has changed, without the need to search through your CI/CD pipelines. Deploy markers log all new deployments in one place and link back to the CI/CD pipelines that caused them.
300300

301-
=== Automatic detection of deployments
301+
See the xref:configure-deploy-markers#[Configure deploy markers] page for full setup details.
302302

303-
CircleCI looks for the word `deploy` in your job names to detect when a deployment may have happened and creates an auto-detected deploy marker.
303+
=== Manual configuration of automatically detected deploys
304304

305-
When CircleCI creates a deploy marker for you automatically, we use the information available in your pipeline configuration to create the following:
305+
If you have some link:https://circleci.com/changelog/auto-generated-deploy-markers-are-being-sunset/[automatically detected deploy markers] you can consider manually configuring them. CircleCI no longer automatically creates deploy markers for you.
306306

307-
* **Component**: CircleCI created a component for the deployment and uses your project name to create a component name.
308-
* **Environment integration**: CircleCI creates an environment for you, using your job and workflow names to attempt to create a relevant name. If an environment name cannot be generated, the name will be `autogenerated`, and you can edit it later. The environment has the type `AUTODETECTED`.
309-
* **Version**: CircleCI uses the build number to populate the version for the purposes of displaying the deployment in the CircleCI web app.
310-
311-
If any of the following conditions are true, CircleCI **will not** automatically generate a deploy marker for a job even if the name contains the word `deploy`:
312-
313-
* The job has a status other than `SUCCESS`.
314-
* Any of the following keywords and keyword combinations are present in the job name:
315-
** `dry run`
316-
** `skip deploy`
317-
** `bypass deploy`
318-
** `deployed`
319-
** `validation`
320-
** `validate`
321-
* The project related to the job has deployments created via the Kubernetes release agent or manual release-type jobs in the last two months.
322-
* You have opted out of the automatic deploy detection feature.
323-
* The detected environment integration name collides with an integration you have already set up.
324-
325-
==== Manual configuration of automatically detected deploys
326307
Some points to consider when manually configuring an automatically detected deploy are as follows:
327308

328-
* If you decide you would like to manually configure a deploy marker for an environment integration that was created as part of an automatically detected deploy, refer to the xref:configure-deploy-markers#[Configure deploy markers] page to set up a deploy marker and a new environment integration.
329-
330309
* If you change a component name that was originally autodetected by CircleCI, we create a new component and the history **will not** carry over. If you do not update the component name, the history **will** carry over.
331310

332311
* If your environment integration has an autogenerated name, you can edit the name as follows:
333-
.. In the link:https://circleci.com/app/home[CircleCI web app], select your organization.
334-
.. Select **Deploys** in the sidebar.
335-
.. Select the **Environments** tab.
336-
.. Find your environment and select cog icon (icon:cog[]) to enter the environment integration settings page.
337-
.. Select **Edit**.
338-
.. Enter a new name and select btn:[Update].
339-
340-
341-
=== Opt out of automatic deploy detection
342-
If you do not want CircleCI to automatically create deploy markers for you, you can opt out of this feature either for a whole organization or per-project.
343-
344-
To opt out of automatic deploy detection for an entire **organization**, follow these steps:
345-
346-
. In the link:https://circleci.com/app/home[CircleCI web app], select your organization.
347-
. Select **Organization settings** in the sidebar.
348-
. Select **Deploys**.
349-
. Toggle the "Enable automatic deploy marker detection" option left. You will see a confirmation message in the bottom right hand corner of the app. To re-enable the feature, toggle the option to the right.
350-
351-
To opt out of automatic deploy detection for a **project**, follow these steps:
352-
312+
+
353313
. In the link:https://circleci.com/app/home[CircleCI web app], select your organization.
354-
. Select **Projects** in the sidebar.
355-
. Find your project in the list, select the ellipsis (icon:ellipsis-h[]), select **Project Settings**.
356-
. Select **Deploys**.
357-
. Toggle the "Enable automatic deploy marker detection" option left. You will see a confirmation message in the bottom right hand corner of the app. To re-enable the feature, toggle the option to the right.
358-
359-
=== Retention Policy
360-
361-
Automatically detected deploys are retained for 30 days.
362-
363-
=== Manual deploy marker setup
364-
365-
If you would rather set up deploy markers yourself, see the xref:configure-deploy-markers#[Configure deploy markers] page.
314+
. Select **Deploys** in the sidebar.
315+
. Select the **Environments** tab.
316+
. Find your environment and select cog icon (icon:cog[]) to enter the environment integration settings page.
317+
. Select **Edit**.
318+
. Enter a new name and select btn:[Update].
366319

367320
[#release-status]
368321
== Deploy status

jekyll/_cci2/introduction-to-the-circleci-web-app.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ Learn more and get started with self-hosted runners on the xref:runner-overview#
247247

248248
**Self-Hosted Runners**: Accept the terms of use to enable self-hosted runners. Once accepted, you can visit the self-hosted runner section of the web application to create resource classes and set up runners.
249249

250-
**Deploys**: Find links to set up deploy markers or deploy monitoring for your projects. Enable/disable autodetected deployments, which allows CircleCI to automatically detect deployments in your projects and create deploy markers for you.
250+
**Deploys**: Find links to set up deploy markers or deploy monitoring for your projects.
251251

252252
**Integrations**: Set up integrations with self-hosted version control systems.
253253

0 commit comments

Comments
 (0)