Skip to content

Latest commit

 

History

History
323 lines (305 loc) · 19.6 KB

nav.adoc

File metadata and controls

323 lines (305 loc) · 19.6 KB

  • About CircleCI

    • CircleCI overview

    • Benefits of CircleCI

    • Concepts

    • Intro to the CircleCI web app

    • Open source acknowledgements

  • Getting started

    • First steps

      • Sign up and try CircleCI

      • Join teammates on CircleCI

      • Create a project

      • Quickstart guide

    • How-to guides

      • Hello World

      • Intro to YAML configuration

      • In-app config editor

      • Node.js quickstart

      • Python quickstart

      • Go quickstart

      • Create an organization

    • Tutorials

      • Configuration intro

      • Use the Slack orb to set up notifications

  • Migrate to CircleCI

    • Migration intro

    • Migrate from AWS

    • Migrate from Azure DevOps

    • Migrate from Buildkite

    • Migrate from GitHub

    • Migrate from GitLab

    • Migrate from Jenkins

    • Migrate from TeamCity

    • Migrate from Travis CI

  • Orchestrate

    • Pipelines

      • Pipeline overview and setup

      • Jobs and steps overview

      • Workflow orchestration

      • Automatic reruns

      • Use workspaces to share data between jobs

      • Use dynamic configuration

      • Skip CI, auto-cancel, and block new pipelines

      • Controlling serial execution across your organization

      • Pipeline values and parameters

    • Triggers

      • Trigger options

      • Set up triggers

      • GitHub trigger event options

      • GitLab trigger options

      • Custom webhooks

      • Schedule triggers

    • How-to guides

      • Orchestration cookbook

      • Set up cross-repo triggers for library consumers

      • How to override config

      • Set up multiple configuration files for a project

      • Notify a Slack channel of a paused workflow

      • Using branch filters

      • Select a workflow to run using pipeline parameters

      • Migrate scheduled workflows to schedule triggers

      • Schedule triggers with multiple workflows

      • Set a nightly schedule trigger

      • Using dynamic configuration

      • Configure databases

      • Migrate from deploy to run

      • Using shell scripts

  • Execute on managed compute

    • Execution environments overview

    • Resource class overview

    • Resource class lifecycle

    • Docker

      • Using Docker

      • Convenience images

      • Migrating to next-gen images

      • Using custom-built Docker images

      • Docker authenticated pulls

      • Running Docker commands

    • Linux VM

      • Using the Linux VM execution environment

      • Using Android images with the machine executor

    • macOS

      • Using the macOS execution environment

      • Configuring a macOS app

      • iOS code signing

    • Windows

      • Using the Windows execution environment

      • Hello world Windows

    • Arm

      • Using the Arm VM execution environment

    • GPU

      • Using the GPU execution environment

    • How-to guides

      • Pull an image from AWS ECR with OIDC

      • Pull an image from GCP Artifact Registry with OIDC

      • Run a job in a container on your machine with Docker

      • Installing and using Docker Compose

      • Debugging container ID cannot be mapped to host ID error

      • Migrating between the Docker machine executors

    • Image support policies

      • Android images support policy

      • Convenience images support policy

      • Linux VM images support policy

      • Linux CUDA images support policy

      • Remote Docker images support policy

      • Windows images support policy

      • Xcode image policy

      • CircleCI image lifecycle: A complete guide

  • Execute jobs on self-hosted runners

    • Self-hosted runner overview

    • Self-hosted runner concepts

    • Runner feature comparison matrix

    • Container runner

      • Container runner installation

      • Container runner performance benchmarks

      • Container runner reference

    • Machine runner 3

      • Install machine runner 3 on Linux

      • Install machine runner 3 on macOS

      • Install machine runner 3 on Windows

      • Install machine runner 3 on Docker

      • Manual install on Linux and macOS

      • Manual install on Windows

      • Migrate from launch agent to machine runner 3 on Linux

      • Migrate from launch agent to machine runner 3 on macOS

      • Migrate from launch agent to machine runner 3 on Windows

      • Machine runner 3 configuration reference

    • Self-hosted runner reference

      • Self-hosted runner API

      • Self-hosted runner FAQ

      • Troubleshoot self-hosted runner

      • Scaling self-hosted runner

  • Testing on CircleCI

    • Run tests on CircleCI

      • Automated testing

      • Collecting test data

      • Test Insights

    • Manage and optimize tests

      • Fix flaky tests

    • Testing strategies

      • Testing LLM-enabled applications through evaluations

      • Browser testing

      • Generate code coverage metrics

      • Re-run failed tests overview

      • Test splitting and parallelism

    • Tutorials

      • Speed up pipelines with test splitting

      • Testing iOS applications

      • Testing macOS applications

    • How-to guides

      • Use the environment CLI to split tests

      • Automate LLM evaluation testing with the CircleCI Evals orb

    • Reference

      • Troubleshoot test splitting

  • Deploy with CircleCI

    • Deployment and deploy management

    • Deploys and rollbacks

      • Set up a rollback pipeline

      • Set up a deploy pipeline

      • Deploy a component

      • Rollback a deployment

      • Configure deploy markers

    • Release agent setup

      • Release agent overview

      • Set up the CircleCI release agent

      • Configure your Kubernetes components

      • Update the Kubernetes release agent

      • Manage releases

    • How-to guides

      • Deploy Android applications

      • Deploy to Artifactory

      • Deploy to AWS

      • Push image to ECR and deploy to ECS

      • Deploy service update to AWS ECS

      • Deploy to Azure Container Registry

      • Deploy to Capistrano

      • Deploy to Cloud Foundry

      • Deploy to Firebase

      • Deploy to Google Cloud Platform

      • Deploy to Heroku

      • Deploy iOS applications

      • Deploy over SSH

      • Publish packages to Packagecloud

      • Deploy to npm registry

  • Optimize

    • Optimizations reference

    • Data

      • Persisting data overview

      • Caching dependencies

      • Caching strategies

      • Store build artifacts

    • Speed

      • Concurrency

      • Test splitting and parallelism

      • Docker layer caching overview

    • Config

      • Dynamic configuration

    • Tutorials

      • Speed up pipelines with test splitting

    • How-to guides

      • Use matrix jobs

      • Using dynamic configuration

      • Avoid and debug Java memory errors

  • Insights

    • Use Insights

    • Test Insights

    • Generate an Insights snapshot badge

    • Insights glossary

  • Manage roles, permissions, and authentication

    • Users, organizations, and integrations guide

    • Roles and permissions

      • Roles and permissions overview

      • Manage roles and permissions

      • Manage groups

      • Prevent unregistered users from spending credits

    • SSO authentication

      • SSO overview

      • SSO setup

      • Set up SSO group mapping with Okta

      • Sign in to an SSO-enabled org

    • Multi-factor authentication (MFA)

      • MFA overview

    • OIDC tokens

      • Use OpenID Connect tokens in jobs

      • OIDC tokens with custom claims

  • Manage security and secrets

    • Security features

      • How CircleCI handles security

      • Intro to environment variables

      • Using contexts

      • IP ranges

      • Audit logs

    • Security recommendations

      • Security overview

      • Protecting against supply chain attacks

      • Secure secrets handling

    • How-to guides

      • Set an environment variable

      • Inject environment variables with the API

      • Debug with SSH

      • Rotate project SSH keys

      • Stop building a project on CircleCI

      • Rename organizations and repositories

      • Delete organizations and projects

  • Manage config policies

    • Config policy management overview

    • Config policy reference

    • How-to guides

      • Create and manage config policies

      • Test config policies

      • Use the CLI for config and policy development

      • Config policies for self-hosted runner

      • Manage contexts with config policies

  • Integration

    • Integration features

      • Outbound webhooks

      • Outbound webhooks reference

      • Notifications

    • VCS integration

      • VCS, pipeline types, and feature support

      • Using the CircleCI GitHub App in an OAuth org

      • Build open source projects

    • Third-party integrations

      • Enable GitHub Checks

      • Connect with Jira

      • New Relic integration

      • Datadog integration

      • Sumo Logic integration

    • How-to guides

      • Adding status badges

      • CircleCI webhooks with Airtable

      • Add additional SSH keys

      • Authorize Google Cloud SDK

  • Developer toolkit

    • How to find IDs

    • AI features

      • Chunk Setup and Overview

      • Using the CircleCI MCP server

      • Intelligent summaries

    • CLI

      • CircleCI environment CLI usage guide

      • Install and configure the CircleCI local CLI

      • How to use the CircleCI local CLI

    • APIs

      • API v2 intro

      • API v2 developers guide

      • Managing API tokens

    • IDE tools

      • VS Code extension overview

      • Get started with the VS Code extension

    • Config tools

      • Config SDK

      • Orb development kit

      • Image Updater

    • Example projects and configs

      • Examples and guides overview

      • Sample config.yml files

      • Database examples

  • Plans and pricing

    • CircleCI plans overview

    • Credits overview

    • Manage budgets

    • Free Plan overview

    • Performance Plan overview

    • Scale Plan overview

    • Server Plan overview