Skip to content

Commit

Permalink
[dev_docs] Add CI tutorial (elastic#124577)
Browse files Browse the repository at this point in the history
* [dev_docs] Add CI tutorial

* typo

* add comments

Co-authored-by: Kibana Machine <[email protected]>
  • Loading branch information
2 people authored and lucasfcosta committed Mar 2, 2022
1 parent 7979664 commit 1268096
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
48 changes: 48 additions & 0 deletions dev_docs/tutorials/ci.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: kibDevTutorialCI
slug: /kibana-dev-docs/tutorials/ci
title: CI
summary: CI
date: 2022-02-03
tags: ['kibana', 'onboarding', 'dev', 'ci']
---

## CI

Kibana uses BuildKite to run a series of checks against each pull requests and tracked branch. Results are posted in pull requests as comments and from the BuildKite UI

### Comments

Comments in pull requests can be used to trigger CI operations.

#### `buildkite test this`

Run test suites and checks.

#### `@elasticmachine merge upstream`

Merge in the most recent changes from upstream.

#### `@elasticmachine run elasticsearch-ci/docs`

Build documentation from the root `docs` folder.

### Labels

Labels can be added to a pull request to run conditional pipelines.

#### `ci:deploy-cloud`

Deploy a pull request to Elastic Cloud. Deployment information will be available as an annotation at the top of a build. Access credentials will be available in vault.

#### `ci:build-all-platforms`

Build Windows, macOS, and Linux archives. Artifacts will be available on the "Artifacts" tab of the "Build Kibana Distribution and Plugins" step.

#### `ci:build-os-packages`

Build Docker images, and Debian and RPM packages. Artifacts will be available on the "Artifacts" tab of the "Build Kibana Distribution and Plugins" step.

#### `ci:all-cypress-suites`

By default, Cypress test suites are only run when code changes are made in certain files, typically files with overlapping test coverage. Adding this label will cause all Cypress tests to run.
1 change: 1 addition & 0 deletions nav-kibana-dev.docnav.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"id": "kibDevTutorialBuildingDistributable",
"label": "Building a Kibana distributable"
},
{ "id": "kibDevTutorialCI" },
{ "id": "kibDevTutorialServerEndpoint" },
{ "id": "kibDevTutorialAdvancedSettings"}
]
Expand Down

0 comments on commit 1268096

Please sign in to comment.