Merge branch 'master' into machine-runner-3-outdated

circleci · Dec 11, 2024 · e251eff · e251eff
2 parents 338ad58 + 6017124
commit e251eff
Show file tree

Hide file tree

Showing 162 changed files with 318 additions and 424 deletions.
diff --git a/jekyll/_cci2/about-circleci.adoc b/jekyll/_cci2/about-circleci.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = CircleCI overview
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/add-ssh-key.adoc b/jekyll/_cci2/add-ssh-key.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Add additional SSH keys to CircleCI
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/android-machine-image.adoc b/jekyll/_cci2/android-machine-image.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Android images with the machine executor
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/api-developers-guide.adoc b/jekyll/_cci2/api-developers-guide.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = CircleCI API developer's guide
 :page-description: API guide for internal and external CircleCI developers

diff --git a/jekyll/_cci2/api-intro.adoc b/jekyll/_cci2/api-intro.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = API v2 introduction
 :description: Introduction to the CircleCI API

diff --git a/jekyll/_cci2/artifacts.adoc b/jekyll/_cci2/artifacts.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Storing build artifacts
 :page-description: Example of uploading artifacts created during a build

diff --git a/jekyll/_cci2/audit-logs.adoc b/jekyll/_cci2/audit-logs.adoc
@@ -1,11 +1,11 @@
 ---
-description: "This document describes the ways CircleCI customers can access their audit logs."
-version:
-- Cloud
-- Server v4.x
-- Server v3.x
+contentTags:
+  platform:
+  - Cloud
+  - Server v4+
 ---
 = Audit logs
+:page-description: "This document describes the ways CircleCI customers can access their audit logs."
 :page-layout: classic-docs
 :page-liquid:
 :icons: font
@@ -20,7 +20,7 @@ If you have administrator permissions for your organization, you can access the
 . Select **Organization Settings** in the web app sidebar.
 . Select **Security** from the menu.
 . Scroll down to the **Audit Log** section and specify a date range.
-. Click **Request audit logs** to download audit logs as a CSV file. Audit log fields with nested data contain JSON blobs.
+. Select **Request audit logs** to download audit logs as a CSV file. Audit log fields with nested data contain JSON blobs.
 
 NOTE: In some situations, the internal machinery may generate duplicate events in the audit logs. The `id` field of the downloaded logs is unique per event and can be used to identify duplicate entries.
 

diff --git a/jekyll/_cci2/authorize-google-cloud-sdk.adoc b/jekyll/_cci2/authorize-google-cloud-sdk.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server 4.x
-  - Server 3.x
+  - Server v4+
 ---
 = Authorize Google Cloud SDK
 :description: How to authorize the Google Cloud SDK

diff --git a/jekyll/_cci2/automate-llm-evaluation-testing-with-the-circleci-evals-orb.adoc b/jekyll/_cci2/automate-llm-evaluation-testing-with-the-circleci-evals-orb.adoc
@@ -1,8 +1,8 @@
 ---
 contentTags:
   platform:
-    - Cloud
-    - Server
+  - Cloud
+  - Server v4+
 ---
 = Automate LLM evaluation testing with the CircleCI Evals orb
 :description: How to use CircleCI Evals orb.

diff --git a/jekyll/_cci2/benefits-of-circleci.adoc b/jekyll/_cci2/benefits-of-circleci.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Benefits of CircleCI
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/browser-testing.adoc b/jekyll/_cci2/browser-testing.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Browser testing
 :page-description: Browser Testing on CircleCI

diff --git a/jekyll/_cci2/building-docker-images.adoc b/jekyll/_cci2/building-docker-images.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Run Docker commands
 :page-description: How to build Docker images using the Docker execution environment

diff --git a/jekyll/_cci2/caching-strategy.adoc b/jekyll/_cci2/caching-strategy.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Caching strategies
 :page-description: A guide to the various caching strategies available for managing dependency caches in CircleCI.
@@ -95,7 +94,7 @@ If you find that a cache is not restored, see link:https://support.circleci.com/
 [#cache-unused-or-superfluous-dependencies]
 === Cache unused or superfluous dependencies
 
-Depending on what language and package management system you are using, you may be able to leverage tools that clear or "`prune`" unnecessary dependencies.
+Depending on what language and package management system you are using, you may be able to leverage tools that clear or _prune_ unnecessary dependencies.
 
 For example, the node-prune package removes unnecessary files (Markdown, TypeScript files, etc.) from `node_modules`.
 

diff --git a/jekyll/_cci2/caching.adoc b/jekyll/_cci2/caching.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Caching dependencies
 :page-description: This document is a guide to caching dependencies in CircleCI pipelines.
@@ -218,14 +217,14 @@ Consider a workflow of 3 jobs, where Job3 depends on Job1 and Job2: `+{Job1, Job
 
 In a run of the workflow, Job3 may use the cache written by Job1 _or_ Job2. Since caches are immutable, this would be whichever job saved its cache first.
 
-This is usually undesirable, because the results are not deterministic. Part of the result depends on chance.
+A caching scenario like this is usually undesirable, because the results are not deterministic. Part of the result depends on chance.
 
 You can make this workflow deterministic by changing the job dependencies. For example, make Job1 and Job2 write to different caches, and Job3 loads from only one. Or ensure there can be only one ordering: `+Job1 -> Job2 -> Job3+`.
 
 [#caching-race-condition-example-2]
 === Caching race condition example 2
 
-There are more complex cases where jobs can save using a dynamic key like {% raw %}`node-cache-{{ checksum "package-lock.json" }}`{% endraw %} and restore using a partial key match like `node-cache-`.
+A more complex caching example could be using a dynamic key, for example, {% raw %}`node-cache-{{ checksum "package-lock.json" }}`{% endraw %} and restoring using a partial key match, for example, `node-cache-`.
 
 A race condition is still possible, but the details may change. For instance, the downstream job uses the cache from the upstream job that ran last.
 
@@ -234,7 +233,7 @@ Another race condition is possible when sharing caches between jobs. Consider a
 [#using-caching-in-monorepos]
 == Using caching in monorepos
 
-There are many different approaches to utilizing caching in monorepos. The following approach can be used whenever you need to manage a shared cache based on multiple files in different parts of your monorepo.
+The following example is one approach to managing a shared cache based on multiple files in different parts of your monorepo.
 
 [#creating-and-building-a-concatenated-package-lock-file]
 === Creating and building a concatenated `package-lock` file

diff --git a/jekyll/_cci2/circleci-images.md b/jekyll/_cci2/circleci-images.md
@@ -5,8 +5,7 @@ description: "Listing of available Docker images maintained by CircleCI"
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 
 

diff --git a/jekyll/_cci2/code-coverage.adoc b/jekyll/_cci2/code-coverage.adoc
@@ -2,8 +2,8 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
+
 ---
 = Generate code coverage metrics
 :page-description: Generate code coverage metrics for different languages.

diff --git a/jekyll/_cci2/collect-test-data.adoc b/jekyll/_cci2/collect-test-data.adoc
@@ -2,8 +2,8 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
+
 sectionTags:
   javascript:
     - "#jest"

diff --git a/jekyll/_cci2/concepts.adoc b/jekyll/_cci2/concepts.adoc
@@ -2,8 +2,8 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
+
 ---
 = Concepts
 :description: CircleCI concepts

diff --git a/jekyll/_cci2/concurrency.adoc b/jekyll/_cci2/concurrency.adoc
@@ -2,8 +2,8 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
+
 ---
 = Concurrency
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/config-editor.adoc b/jekyll/_cci2/config-editor.adoc
@@ -2,8 +2,8 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
+
 ---
 = Using the CircleCI in-app configuration editor
 :page-description: Docs page on In-app configuration editor use and features

diff --git a/jekyll/_cci2/config-intro.adoc b/jekyll/_cci2/config-intro.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Configuration introduction
 :page-layout: classic-docs
@@ -316,7 +315,7 @@ To approve the job, click the thumbs up icon to the right of the _Hold-for-Appro
 
 Now you will see a tick in the Actions column and your jobs should complete.
 
-Click on the _Now-Complete_ job, then the _Approval Complete_ step. You should see the output of your command: `The work is now complete`.
+Select the _Now-Complete_ job, then the _Approval Complete_ step. You should see the output of your command: `The work is now complete`.
 
 image::config-approval-complete.png[Approval complete]
 

diff --git a/jekyll/_cci2/config-policies-for-self-hosted-runner.adoc b/jekyll/_cci2/config-policies-for-self-hosted-runner.adoc
@@ -3,7 +3,7 @@ description: Learn how to write a policy to restrict which projects can run jobs
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
+  - Server v4+
 ---
 = Config policies for self-hosted runner
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/config-policy-management-overview.adoc b/jekyll/_cci2/config-policy-management-overview.adoc
@@ -3,7 +3,7 @@ description: Config policies for CircleCI project configurations.
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
+  - Server v4+
 ---
 = Config policies overview
 :page-layout: classic-docs
@@ -173,13 +173,13 @@ In OPA, rules can produce any type of output. At CircleCI, rules that produce vi
 * String array
 * Map of string to string
 
-This is because rule violations must produce error messages that individual contributors and SecOps can act upon.
+This restriction is in place so that rule violations produce error messages that individual contributors and SecOps can act upon.
 Helper rules that produce differently typed outputs can still be defined, but rules that will be considered when making CircleCI decisions must have the output types specified above. For more information see the <<#enablement>> section below.
 
 [#evaluation]
 ===== Evaluation
 
-This is how the decision engine determines if a config violates the given policy. The evaluation defines the name and ID of the rule, checks a condition, and returns a user-friendly string describing the violation. Rule evaluations include the **rule name** and an **optional rule ID**. The rule name will be used to enable and set the enforcement level for a rule.
+Evaluation is how the decision engine determines if a config violates the given policy. The evaluation defines the name and ID of the rule, checks a condition, and returns a user-friendly string describing the violation. Rule evaluations include the **rule name** and an **optional rule ID**. The rule name will be used to enable and set the enforcement level for a rule.
 
 [source,rego]
 ----
@@ -426,7 +426,7 @@ workflows:
 
 In the above example, the policy is bypassed and will **not trigger**. The policy inspects `jobs` and does not find a `resource_class == "large"`.
 
-This is problematic because once the configuration is compiled, the job `test` will have a `resource_class == "large"`.
+This example is problematic because once the configuration is compiled, the job `test` will have a `resource_class == "large"`.
 
 Another way this policy could be unintentionally bypassed is by using parameters. Consider the following configuration, which uses a parameter to set the resource class for an executor:
 

diff --git a/jekyll/_cci2/config-policy-reference.adoc b/jekyll/_cci2/config-policy-reference.adoc
@@ -3,7 +3,7 @@ description: Open preview of config policies for CircleCI. Reference page for fu
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
+  - Server v4+
 ---
 = Config policy reference
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/configuration-reference.adoc b/jekyll/_cci2/configuration-reference.adoc
@@ -3,8 +3,7 @@ readtime: false
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 sectionTags:
   config-version-2:
     - "#version"

diff --git a/jekyll/_cci2/contexts.adoc b/jekyll/_cci2/contexts.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Using contexts
 :page-description: Secured, cross-project resources

diff --git a/jekyll/_cci2/convenience-images-support-policy.adoc b/jekyll/_cci2/convenience-images-support-policy.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = CircleCI convenience images support policy
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/create-an-orb.adoc b/jekyll/_cci2/create-an-orb.adoc
@@ -2,8 +2,7 @@
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
-  - Server v3.x
+  - Server v4+
 ---
 = Create an orb
 :page-layout: classic-docs

diff --git a/jekyll/_cci2/create-and-manage-config-policies.adoc b/jekyll/_cci2/create-and-manage-config-policies.adoc
@@ -3,7 +3,7 @@ description: Learn how to write and manage config policies for CircleCI project
 contentTags:
   platform:
   - Cloud
-  - Server v4.x
+  - Server v4+
 ---
 = Create and manage config policies
 :page-layout: classic-docs
@@ -84,11 +84,11 @@ For the config policies pipeline recommended in this guide you will need to secu
 
 You can do this using a context. For more information about setting up and using contexts to securely manage environment variables see the xref:contexts#[Using contexts] page. You might already have a context set up for this or you might want to create a new one. For this example the context name `my-context` is used.
 
-. In the CircleCI web app, select **Organization settings > Contexts**
-. Click **Create Context** and enter a name for your context, for example `my-context`
-. Click your new context name in the list to access options
-. Click **Add Environment Variable** and enter `CIRCLECI_CLI_TOKEN` for the environment variable name, and your personal API token string for the value (For more information about this see the xref:local-cli#configure-the-cli[Installing the CircleCI local CLI] page). Then click **Add Environment Variable** again to complete.
-. Click **Add Environment Variable** and enter `ORG_ID` for the environment variable name, and your organization ID for the value.
+. In the CircleCI web app, select **Organization settings > Contexts**.
+. Select **Create Context** and enter a name for your context, for example `my-context`.
+. Select your new context name in the list to access options.
+. Select **Add Environment Variable** and enter `CIRCLECI_CLI_TOKEN` for the environment variable name, and your personal API token string for the value (For more information about this see the xref:local-cli#configure-the-cli[Installing the CircleCI local CLI] page). Then click **Add Environment Variable** again to complete.
+. Select **Add Environment Variable** and enter `ORG_ID` for the environment variable name, and your organization ID for the value.
 +
 {% include snippets/find-organization-id.adoc %}