Skip to content

Commit

Permalink
fix conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
rosieyohannan committed Jan 27, 2025
2 parents ab1ad3c + b1a67da commit 1c373fb
Show file tree
Hide file tree
Showing 258 changed files with 2,713 additions and 3,957 deletions.
5 changes: 2 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ version: 2.1 # Set the CI version.
# Learn more about orbs: https://circleci.com/orbs/
orbs:
ruby: circleci/[email protected]
node: circleci/node@6.3.0
node: circleci/node@7.0.0
md-proofer: hubci/[email protected]
vale: circleci/vale@1.1.1
vale: circleci/vale@1.2.0

# This is using the new Scheduled Pipeline feature.
# Right now (10/2021) there is no UI to configure it, so if you need to
Expand Down Expand Up @@ -111,7 +111,6 @@ workflows:
jobs:
- vale/lint:
reference_branch: master
base_dir: ~/project/jekyll/_cci2/

build-deploy:
when:
Expand Down
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ gem "kramdown-parser-gfm"
gem 'liquid-c', '~> 4.0.1'
gem 'htmlcompressor'
gem 'htmlentities', '~> 4.3', '>= 4.3.4'
gem 'nokogiri', '~> 1.16.5'
gem 'nokogiri', '~> 1.18.0'

group :jekyll_plugins do
gem 'jekyll-sitemap'
Expand Down
16 changes: 8 additions & 8 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ GEM
console (~> 1.26)
fiber-annotation
io-event (~> 1.6, >= 1.6.5)
bigdecimal (3.1.8)
bigdecimal (3.1.9)
colorator (1.1.0)
concurrent-ruby (1.3.4)
console (1.27.0)
fiber-annotation
fiber-local (~> 1.1)
json
csv (3.3.0)
dotenv (3.1.4)
csv (3.3.2)
dotenv (3.1.7)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
Expand Down Expand Up @@ -127,11 +127,11 @@ GEM
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
mini_mime (1.1.5)
mini_portile2 (2.8.7)
mini_portile2 (2.8.8)
multi_xml (0.7.1)
bigdecimal (~> 3.1)
multipart-post (2.1.1)
nokogiri (1.16.7)
nokogiri (1.18.1)
mini_portile2 (~> 2.8.2)
racc (~> 1.4)
octokit (4.20.0)
Expand All @@ -146,10 +146,10 @@ GEM
ruby-rc4
ttfunk
progressbar (1.13.0)
pronto (0.11.2)
pronto (0.11.3)
gitlab (>= 4.4.0, < 5.0)
httparty (>= 0.13.7, < 1.0)
octokit (>= 4.7.0, < 8.0)
octokit (>= 4.7.0, < 10.0)
rainbow (>= 2.2, < 4.0)
rexml (>= 3.2.5, < 4.0)
rugged (>= 0.23.0, < 2.0)
Expand Down Expand Up @@ -202,7 +202,7 @@ DEPENDENCIES
jekyll-sitemap
kramdown-parser-gfm
liquid-c (~> 4.0.1)
nokogiri (~> 1.16.5)
nokogiri (~> 1.18.0)
pronto
pronto-markdownlint
rake
Expand Down
5 changes: 2 additions & 3 deletions jekyll/_cci2/about-circleci.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
contentTags:
platform:
- Cloud
- Server v4.x
- Server v3.x
- Server v4+
---
= CircleCI overview
:page-layout: classic-docs
Expand Down Expand Up @@ -48,7 +47,7 @@ CircleCI may be configured to deploy code to various environments, including (bu
* Android
* iOS

The link:https://circleci.com/developer/orbs[orbs registry] contains packages of reusable configuration that can be used for common deployment targets. Orbs simplify and streamline your configuration.
The link:https://circleci.com/developer/orbs[orbs registry] contains packages of reusable configuration for common deployment targets. Orbs simplify and streamline your configuration.

Other cloud service deployments can be scripted using SSH, or by installing the API client of the service with your job configuration.

Expand Down
3 changes: 1 addition & 2 deletions jekyll/_cci2/add-ssh-key.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions jekyll/_cci2/android-machine-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
172 changes: 75 additions & 97 deletions jekyll/_cci2/api-developers-guide.adoc

Large diffs are not rendered by default.

105 changes: 4 additions & 101 deletions jekyll/_cci2/api-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
contentTags:
platform:
- Cloud
- Server v4.x
- Server v3.x
- Server v4+
---
= API v2 introduction
:description: Introduction to the CircleCI API
Expand All @@ -12,68 +11,16 @@ contentTags:
:page-layout: classic-docs
:page-liquid:

The CircleCI API may be used to make API calls to retrieve detailed information about users, jobs, workflows, and pipelines. There are currently two supported API versions:
The CircleCI API may be used to make API calls to interact with your pipelines, projects and orgs, including retrieving detailed information about users, jobs, workflows, and pipelines, as well as triggering pipelines. There are currently two supported API versions:

* link:https://circleci.com/docs/api/v1/[API v1.1 Reference]
* link:https://circleci.com/docs/api/v2/[API v2 Reference]

API v2 includes several powerful features (for example, support for pipelines and pipeline parameters) that are unavailable in API v1.1. It is recommended that CircleCI cloud users migrate their scripts to API v2 stable endpoints as soon as possible.
API v2 includes several powerful features (for example, support for pipelines and pipeline parameters) that are unavailable in API v1.1. It is recommended that CircleCI users migrate their scripts to API v2 stable endpoints as soon as possible.

CircleCI API v1.1 and v2 are supported and generally available. CircleCI expects to eventually End-Of-Life (EOL) API v1.1 in favor of API v2. Further guidance on when CircleCI API v1.1 will be discontinued will be communicated at a future date.

[#overview]
== Overview

CircleCI API v2 enables you to use endpoints with several new features that improve the API experience, in addition to optimizing how you use the API for your jobs.

The current categories of the API v2 endpoints are:

{% include snippets/api-v2-endpoints.adoc %}

NOTE: Currently, xref:managing-api-tokens#creating-a-personal-api-token[Personal API tokens] are the only supported tokens on API v2. xref:managing-api-tokens#creating-a-project-api-token[Project tokens] are not currently supported on API v2.

[#getting-started-with-the-api-v2]
== Getting started with the API v2

[NOTE]
====
*GitHub App and GitLab users:* Note that the definition of *project slug* provided in this section, as well as its usage throughout this document applies to GitHub and Bitbucket Cloud projects only. GitLab, GitHub App and Bitbucket Data Center projects currently use a new slug format:
`circleci/:slug-remainder`
The project slug for GitLab, GitHub App and Bitbucket Data Center projects can be found by navigating to your project in the CircleCI web app and taking the string from the browser address bar. The slug must be treated as an opaque string and passed in its entirety in API requests. Read the xref:api-developers-guide#getting-started-with-the-api[API Developer's Guide] for more details.
====

CircleCI API v2 uses a string representation called the `project_slug`, which is a "triplet" of your version control system (VCS), the name of your organization, and the name of the repository. `project_slug` takes the following form:

[,shell]
----
:vcs_type/:org_name/:repo_name
----

The `project_slug` is included in the response payload when pulling information about a project as well as when looking up a pipeline or workflow by ID. The `project_slug` can then be used to get information about the project. For GitHub OAuth app and Bitbucket Cloud projects, it is currently usable as a human-readable identifier for a given project.

[#authentication]
== Authentication

The CircleCI API v2 enables users to be authenticated by sending your xref:managing-api-tokens#creating-a-personal-api-token[Personal API token] as an HTTP header in the request, with the name `Circle-Token` and the token as the value. You can find examples in the xref:api-developers-guide#[API Developer's Guide].

[discrete#triggering-a-pipeline-with-parameters-example]
==== Triggering a pipeline with parameters example

Here is a simple example using `curl` to trigger a pipeline with parameters:

[,shell]
----
curl -X POST --header "Content-Type: application/json" --header "Circle-Token: $CIRCLE_TOKEN" -d '{
"parameters": {
"myparam": "./myspecialdir",
"myspecialversion": "4.8.2"
}
}' https://circleci.com/api/v2/project/{project_slug}/pipeline
----

NOTE: Pipeline parameters are *not* treated as sensitive data and *must not* be used for sensitive values (secrets). You can find information on using sensitive data correctly in the xref:security-overview#[Security overview] and xref:glossary#context[Contexts] guides.
To get started with the API v2, see the xref:api-developers-guide#[API developers guide].

[#changes-in-endpoints]
== Changes in endpoints
Expand All @@ -82,50 +29,6 @@ The CircleCI API v2 release includes several new endpoints, and deprecates some

For a complete list of all API v2 endpoints, refer to the https://circleci.com/docs/api/v2/[API v2 Reference Guide], which contains a detailed description of each individual endpoint, as well as information on required and optional parameters, HTTP status and error codes, and code samples you may use in your workflows.

[#new-endpoints]
=== New endpoints

The table below describes endpoints that have been added to the CircleCI API in v2.

[.table.table-striped]
[cols=2*, options="header", stripes=even]
|===
| Endpoint | Description

| `GET /workflow/:id`
| Returns an individual workflow based on the `id` parameter being passed in the request.

| `GET /workflow/:id/job`
| Retrieves all Jobs associated with a specific workflow, based on its unique `id`.

| `GET /project/:project_slug`
| Retrieves a specific project by its unique slug.

| `POST /project/:project_slug/pipeline`
| Retrieves an individual project by its unique slug.

| `GET /pipeline/:id`
| Retrieves an individual pipeline, based on the `id` passed in the request.

| `GET /pipeline/:id/config`
| Retrieves the configuration of a specific pipeline.

| `GET /project/:project_slug/pipelines/[:filter]`
| Retrieves the most recent set of pipelines for a Project.

| `GET /insights/:project-slug/workflows`
| Retrieves summary metrics for an individual project's workflow.

| `GET /insights/:project-slug/workflows/:workflow-name`
| Retrieves recent runs for a workflow.

| `GET /insights/:project-slug/workflows/:workflow-name/jobs`
| Retrieves summary metrics for a project workflow's jobs.

| `GET /insights/:project-slug/workflows/:workflow-name/jobs/:job-name`
| Retrieves recent runs of a job within a workflow.
|===

[#deprecated-endpoints]
=== Deprecated endpoints

Expand Down
5 changes: 3 additions & 2 deletions jekyll/_cci2/artifacts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -141,6 +140,8 @@ When CircleCI runs a job, a link to the core dump file appears in the *Artifacts
[#downloading-all-artifacts-for-a-build-on-circleci]
== Downloading all artifacts for a build on CircleCI

include::../_includes/partials/notes/server-api-examples.adoc[]

To download your artifacts with `curl`, follow the steps below.

. xref:managing-api-tokens#creating-a-personal-api-token[Create a personal API token] and copy it to a clipboard.
Expand Down
12 changes: 6 additions & 6 deletions jekyll/_cci2/audit-logs.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

Expand Down
3 changes: 1 addition & 2 deletions jekyll/_cci2/authorize-google-cloud-sdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions jekyll/_cci2/benefits-of-circleci.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
contentTags:
platform:
- Cloud
- Server v4.x
- Server v3.x
- Server v4+
---
= Benefits of CircleCI
:page-layout: classic-docs
Expand Down
2 changes: 1 addition & 1 deletion jekyll/_cci2/bitbucket-data-center-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ You can add or delete pipelines and triggers for your project. For details see t

* You can optionally choose to enable the auto-cancel xref:skip-build#auto-cancel[redundant workflows setting]
* You can enable dynamic configuration using setup workflows in CircleCI. To learn about dynamic configuration, read the xref:dynamic-config#[Dynamic configuration] guide.
* At this time, the **Free and Open Source** setting is not currently supported, but there are plans to make this available in the future.
* At this time, the **Free and Open Source** setting is not currently supported for Bitbucket Data Center, but there are plans to make this available in the future.

[#ssh-keys]
=== Additional SSH keys
Expand Down
3 changes: 1 addition & 2 deletions jekyll/_cci2/browser-testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
contentTags:
platform:
- Cloud
- Server v4.x
- Server v3.x
- Server v4+
---
= Browser testing
:page-description: Browser Testing on CircleCI
Expand Down
3 changes: 1 addition & 2 deletions jekyll/_cci2/building-docker-images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions jekyll/_cci2/caching-strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`.

Expand Down
Loading

0 comments on commit 1c373fb

Please sign in to comment.