Drone CI / CD

https://docs.drone.io/
Admin
Drone by Harness™ is a modern Continuous Integration platform that empowers teams to automate their...
Tokens:223,075
Snippets:2,897
Trust Score:9.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and start the service

Source: https://docs.drone.io/runner/exec/installation/macos

Installs and starts the exec runner service.

```bash
$ drone-runner-exec service install
$ drone-runner-exec service start

```

--------------------------------

### Basic DigitalOcean pipeline with backend and frontend steps

Source: https://docs.drone.io/pipeline/digitalocean/syntax/steps

Example configuration showing a complete pipeline with two steps: backend (go build, go test) and frontend (npm install, npm test). The token is sourced from a secret.

```yaml
kind: pipeline
type: digitalocean
name: default

token:
  from_secret: token

steps:
- name: backend
  commands:
  - go build
  - go test

- name: frontend
  commands:
  - npm install
  - npm test

```

--------------------------------

### drone repo enable - example usage

Source: https://docs.drone.io/cli/repo/drone-repo-enable

Example command to enable the repository 'octocat/hello-world'.

```bash
$ drone repo enable octocat/hello-world
```

--------------------------------

### Example Azure Pool Setup (pool.yml)

Source: https://docs.drone.io/runner/vm/drivers/azure

Example pool.yml file configuring a pool with a pool size of 1 and a limit of 4. Uses Ubuntu 18.04 image and includes account, location, size, tags, and image configuration.

```yaml
version: "1"
instances:

- name: ubuntu-azure
    default: true
    type: azure
    pool: 1    # total number of warm instances in the pool at all times
    limit: 4   # limit the total number of running servers. If exceeded block or error.
    platform:
      os: linux
      arch: amd64
    spec:
      account:
      client_id: XXXXXXX
      client_secret: XXXXXXX
      subscription_id: XXXXXXX
      tenant_id: XXXXXXXXX
      location: eastus2
      size : Standard_F2s
      tags:
        tagName: tag
      image:
        username: azureuser
        password: password123!
        publisher: Canonical
        offer: UbuntuServer
        sku: 18.04-LTS
        version: latest
```

--------------------------------

### Example pool setup - pool.yml with two pools

Source: https://docs.drone.io/runner/vm/drivers/amazon

Example pool.yml configuration that sets up 2 pools each with a pool size of 2 and a limit of 4. The snippet shows a single instance definition with pool and limit settings.

```yaml
version: "1"
instances:
  - name: ubuntu-aws
    default: true
    type: amazon
    pool: 1    # total number of warm instances in the pool at all times
    limit: 4   # limit the total number of running servers. If exceeded block or error.
    platform:
      os: linux
      arch: amd64
    spec:
      account:
        region: us-east-2
        availability_zone: us-east-2c
        access_key_id: XXXXXXXXXXXXXXXXXXXXX
        access_key_secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      ami: ami-051197ce9cbb023ea
      size: t2.nano
      network:
        security_groups:
          - XXXXXXXXXXXXXXXX

```

--------------------------------

### drone build info example

Source: https://docs.drone.io/cli/build/drone-build-info

Example command that displays build metadata for build 42 of the octocat/hello-world repository.

```shell
$ drone build info octocat/hello-world 42
```

--------------------------------

### drone build approve example

Source: https://docs.drone.io/cli/build/drone-build-approve

Example command that approves the 'default' stage of build 42 for the octocat/hello-world repository.

```bash
$ drone build approve octocat/hello-world 42 default

```

--------------------------------

### drone build last - Example Usage

Source: https://docs.drone.io/cli/build/drone-build-last

Example command to show the latest build details for the repository octocat/hello-world.

```bash
$ drone build last octocat/hello-world

```

--------------------------------

### Example pipeline configuration in .drone.yml

Source: https://docs.drone.io/pipeline/overview

Place this configuration in a .drone.yml file at the root of your git repository. It defines a Docker pipeline with two steps: a backend step using the golang image to build and test Go code, and a frontend step using the node image to install dependencies and run tests.

```yaml
---
kind: pipeline
type: docker
name: default

steps:
- name: backend
  image: golang
  commands:
  - go build
  - go test

- name: frontend
  image: node
  commands:
  - npm install
  - npm run test

...

```

--------------------------------

### Example response body

Source: https://docs.drone.io/api/builds/build_promote

Example JSON response for a promote request, showing build and stage details.

```json
{
    "id": 100207,
    "repo_id": 296163,
    "number": 42,
    "status": "pending",
    "event": "promote",
    "link": "https://github.com/octoat/hello-world/compare/e3320539a4c0...9fc1ad6ebf12",
    "message": "updated README",
    "before": "e3320539a4c03ccfda992641646deb67d8bf98f3",
    "after": "9fc1ad6ebf12462f3f9773003e26b4c6f54a772e",
    "ref": "refs/heads/master",
    "source_repo": "spaceghost/hello-world",
    "source": "master",
    "target": "master",
    "author_login": "octocat",
    "author_name": "The Octocat",
    "author_email": "octocat@github.com",
    "author_avatar": "http://www.gravatar.com/avatar/7194e8d48fa1d2b689f99443b767316c",
    "sender": "bradrydzewski",
    "started": 0,
    "finished": 0,
    "created": 1564085874,
    "updated": 1564085874,
    "version": 1,
    "stages": [
        {
            "id": 199937,
            "repo_id": 296163,
            "build_id": 100207,
            "number": 1,
            "name": "default",
            "kind": "pipeline",
            "type": "docker",
            "status": "pending",
            "errignore": false,
            "exit_code": 0,
            "machine": "15e89c0f84f1",
            "os": "linux",
            "arch": "amd64",
            "started": 0,
            "stopped": 0,
            "created": 1564085874,
            "updated": 1564086343,
            "version": 1,
            "on_success": true,
            "on_failure": false
        }
    ]
}
```

--------------------------------

### Example environment file

Source: https://docs.drone.io/runner/exec/installation/macos

Example configuration file using <variable>=value syntax. Comments are denoted with #. This is not a bash file; bash syntax and expressions are not supported.

```plaintext
DRONE_RPC_PROTO=https
DRONE_RPC_HOST=drone.company.com
DRONE_RPC_SECRET=super-duper-secret
DRONE_RUNNER_PATH=/usr/local/bin:/usr/bin:/usr/sbin:/sbin

```

--------------------------------

### drone build decline example

Source: https://docs.drone.io/cli/build/drone-build-decline

Example command that declines the named stage. The example declines the 'default' stage of build 42 in the 'octocat/hello-world' repository.

```bash
$ drone build decline octocat/hello-world 42 default

```

--------------------------------

### Install Drone CLI on OSX using Homebrew

Source: https://docs.drone.io/cli/install

Installs the Drone CLI using Homebrew by tapping the drone/drone repository and then installing the drone package.

```bash
$ brew tap drone/drone
$ brew install drone
```

--------------------------------

### Setup command for Google: drone-runner-aws setup with expected output and pool file

Source: https://docs.drone.io/runner/vm/configuration/setup

Run the setup command with the Google provider to verify the configuration. The expected output is shown, including the pool file that is used when no pool file is provided. The pool file defines a testpool instance with specific Google Cloud settings.

```log
./drone-runner-aws setup --google-project-id myProjectId
INFO[0000] setup: using google
INFO[0000] no pool file provided
INFO[0000] in memory pool is using google
DEBU[0000] finding default firewall rules
DEBU[0000] found default firewall rule
TRAC[0000] google: creating VM                           cloud=google image=projects/ubuntu-os-pro-cloud/global/images/ubuntu-pro-1804-bionic-v20220131 name=setup-testpool-1655380357 pool=testpool size=e2-small zone=northamerica-northeast1-a
DEBU[0010] instance insert operation completed           cloud=google image=projects/ubuntu-os-pro-cloud/global/images/ubuntu-pro-1804-bionic-v20220131 name=setup-testpool-1655380357 pool=testpool size=e2-small zone=northamerica-northeast1-a
DEBU[0010] google: [provision] VM provisioned            cloud=google fields.time=9.85s image=projects/ubuntu-os-pro-cloud/global/images/ubuntu-pro-1804-bionic-v20220131 ip=2360638475713554281 name=setup-testpool-1655380357 pool=testpool size=e2-small zone=northamerica-northeast1-a
DEBU[0010] google: [provision] complete                  cloud=google fields.time=10.09s image=projects/ubuntu-os-pro-cloud/global/images/ubuntu-pro-1804-bionic-v20220131 ip=34.152.16.141 name=setup-testpool-1655380357 pool=testpool size=e2-small zone=northamerica-northeast1-a
ERRO[0010] setup: unable to get instance logs            error=Unimplemented
INFO[0010] setup: instance logs for 4546377208440465258:  
TRAC[0010] setup: running healthcheck and waiting for an ok response
TRAC[0043] health check failed. Retrying                 error="Get \"https://34.152.16.141:9079/healthz\": dial tcp 34.152.16.141:9079: connect: connection refused" retry_num=0
TRAC[0143] RetryHealth: health check completed           duration=2m12.159454s
TRAC[0143] LE.RetryHealth check complete                 response="&{Version:0.1.0 DockerInstalled:true GitInstalled:true LiteEngineLog:time=\"2022-06-16T11:54:58Z\" level=info msg=\"server listening at port :9079\"\ntime=\"2022-06-16T11:54:58Z\" level=info msg=\"checking git is installed\"\ntime=\"2022-06-16T11:54:58Z\" level=info msg=\"git is installed\"\ntime=\"2022-06-16T11:54:58Z\" level=info msg=\"checking docker is installed\"\nCONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES\ntime=\"2022-06-16T11:54:58Z\" level=info msg=\"docker is installed\"\ntime=\"2022-06-16T11:54:59Z\" level=info msg=\"handler: HandleHealth()\"\ntime=\"2022-06-16T11:54:59Z\" level=info msg=\"checking docker is installed\"\nCONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES\ntime=\"2022-06-16T11:54:59Z\" level=info msg=\"docker is installed\"\ntime=\"2022-06-16T11:54:59Z\" level=info msg=\"checking git is installed\"\ntime=\"2022-06-16T11:54:59Z\" level=info msg=\"git is installed\"\n OK:true}"
```

```yaml
version: "1"
instances:
- name: testpool
  default: true
  type: google
  pool: 1
  limit: 2
  platform:
    os: linux
    arch: amd64
  spec:
    account:
      project_id: drone-ci-289110
      json_path: ~/.config/gcloud/application_default_credentials.json
    image: projects/ubuntu-os-pro-cloud/global/images/ubuntu-pro-1804-bionic-v20220131
    machine_type: e2-small
    zone:
    - northamerica-northeast1-a
```

--------------------------------

### SSH pipeline configuration example

Source: https://docs.drone.io/pipeline/ssh/overview

Full example of an SSH pipeline configuration with server connection details and a greeting step that echoes 'hello world'.

```yaml
---
kind: pipeline
type: ssh
name: default

server:
  host: 1.2.3.4
  user: root
  password:
    from_secret: password

steps:
- name: greeting
  commands:
  - echo hello world

...
```

--------------------------------

### drone template info example usage

Source: https://docs.drone.io/cli/template/drone-template-info

Example command that displays template info for the template 'plugin.starklark' in the 'octocat' namespace.

```bash
$ drone template info --name plugin.starklark --namespace octocat
```

--------------------------------

### drone log view example

Source: https://docs.drone.io/cli/drone-log

Example of viewing a log for a specific build, stage, and step.

```text
drone log view octocat/hello-world 19 1 3
```

--------------------------------

### drone cron enable example

Source: https://docs.drone.io/cli/cron/drone-cron-enable

Example command that enables the 'nightly' cron job for the 'octocat/hello-world' repository.

```bash
drone cron enable octocat/hello-world nightly
```

--------------------------------

### drone template ls - example usage

Source: https://docs.drone.io/cli/template/drone-template-ls

Example command that lists templates for the 'octocat' namespace. Requires push privileges to the repository.

```bash
$ drone template ls octocat

```

--------------------------------

### Install Dependencies on VM

Source: https://docs.drone.io/runner/vm/drivers/anka

Installs Homebrew, wget, and Docker (cask) on the VM. Note: Docker is not supported on M1 architectures.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

brew install wget

brew install docker —-cask
```

--------------------------------

### drone sign example with --save

Source: https://docs.drone.io/cli/drone-sign

Example usage that signs the YAML file for the repository octocat/hello-world and saves the result to the source file.

```bash
drone sign --save octocat/hello-world
```

--------------------------------

### drone cron info example

Source: https://docs.drone.io/cli/cron/drone-cron-info

Example command to display cron info for a specific repository and cron job. Requires push privileges.

```bash
drone cron info octocat/hello-world nightly

```

--------------------------------

### Example response body

Source: https://docs.drone.io/api/builds/build_create

Example JSON response from the build creation API, showing the build object with stages and metadata.

```json
{
    "id": 100207,
    "repo_id": 296163,
    "number": 42,
    "status": "pending",
    "event": "custom",
    "action": "sync",
    "link": "https://github.com/octoat/hello-world/compare/e3320539a4c0...9fc1ad6ebf12",
    "message": "updated README",
    "before": "e3320539a4c03ccfda992641646deb67d8bf98f3",
    "after": "9fc1ad6ebf12462f3f9773003e26b4c6f54a772e",
    "ref": "refs/heads/master",
    "source_repo": "spaceghost/hello-world",
    "source": "develop",
    "target": "master",
    "author_login": "octocat",
    "author_name": "The Octocat",
    "author_email": "octocat@github.com",
    "author_avatar": "http://www.gravatar.com/avatar/7194e8d48fa1d2b689f99443b767316c",
    "sender": "bradrydzewski",
    "started": 0,
    "finished": 0,
    "created": 1564085874,
    "updated": 1564085874,
    "version": 1,
    "stages": [
        {
            "id": 199937,
            "repo_id": 296163,
            "build_id": 100207,
            "number": 1,
            "name": "default",
            "kind": "pipeline",
            "type": "docker",
            "status": "pending",
            "errignore": false,
            "exit_code": 0,
            "machine": "15e89c0f84f1",
            "os": "linux",
            "arch": "amd64",
            "started": 0,
            "stopped": 0,
            "created": 1564085874,
            "updated": 1564086343,
            "version": 1,
            "on_success": true,
            "on_failure": false
        }
    ]
}

```

--------------------------------

### drone user add - example adding a user by username

Source: https://docs.drone.io/cli/user/drone-user-add

Example command that adds a user by username. The command requires administrative privileges.

```bash
$ drone user add octocat
```

--------------------------------

### Initialization problem example

Source: https://docs.drone.io/pipeline/docker/examples/services/couchdb

Shows a pipeline that may fail if the CouchDB container is not given adequate time to initialize. The example uses a sleep command before attempting to connect.

```yaml
---
kind: pipeline
name: default

steps:
- name: test
  image: coucdb:2.2
  commands:
  - sleep 15
  - curl http://database:5984

```

--------------------------------

### Example API Request with curl

Source: https://docs.drone.io/api/overview

Example curl command to GET the /api/user endpoint, passing the bearer token in the Authorization header. Replace the token and URL as needed.

```bash
curl -X GET "http://localhost:8080/api/user" \
  -H "Authorization: Bearer AKIAIOSFODNN7EXAMPLE"
```

--------------------------------

### Example pipeline configuration

Source: https://docs.drone.io/pipeline/configuration

Basic pipeline configuration with a single step that builds and tests Go code.

```yaml
kind: pipeline
type: docker
name: default

steps:
- name: test
  image: golang
  commands:
  - go build
  - go test

```

--------------------------------

### Basic Dart pipeline with pub get and pub run test

Source: https://docs.drone.io/pipeline/docker/examples/languages/dart

Defines a Drone pipeline named 'default' that runs 'pub get' and 'pub run test' inside the 'google/dart' Docker image, downloaded at runtime from DockerHub. Use this as a starting point for Dart projects.

```yaml
kind: pipeline
name: default

steps:
- name: test
  image: google/dart
  commands:
  - pub get
  - pub run test

```

--------------------------------

### Run the DigitalOcean runner container

Source: https://docs.drone.io/runner/digitalocean/installation

Creates and starts the runner container with the required environment variables and volume mounts for SSH keys. Replace the example values with your Drone server details.

```bash
docker run -d \
  --volume=/path/on/host/id_rsa:/path/in/container/id_rsa \
  --volume=/path/on/host/id_rsa.pub:/path/in/container/id_rsa.pub \
  --env=DRONE_RPC_PROTO=https \
  --env=DRONE_RPC_HOST=drone.company.com \
  --env=DRONE_RPC_SECRET=super-duper-secret \
  --env=DRONE_PUBLIC_KEY_FILE=/path/in/container/id_rsa.pub \
  --env=DRONE_PRIVATE_KEY_FILE=/path/in/container/id_rsa \
  --publish=3000:3000 \
  --restart always \
  --name runner \
  drone/drone-runner-digitalocean

```

--------------------------------

### Pipeline configuration with a pipeline named test

Source: https://docs.drone.io/quickstart/cli

Example YAML configuration defining a Docker pipeline named 'test' with a single step 'dist' that runs npm install and npm run dist.

```yaml
kind: pipeline
type: docker
name: test

steps:
- name: dist
  image: node
  commands:
  - npm install
  - npm run dist

```

--------------------------------

### Digital Ocean setup command with pool file

Source: https://docs.drone.io/runner/vm/configuration/setup

Runs the setup command configuring a Digital Ocean pool with a personal access token. The output shows instance creation, firewall configuration, healthcheck, and VM termination logs. The pool file defines a testpool named 'testpool' with DigitalOcean type, one initial instance, and a limit of two.

```text
./drone-runner-aws setup --digital-ocean-pat XXXXXXXXX
INFO[0000] setup: using digital ocean
INFO[0000] no pool file provided
INFO[0000] in memory pool is using digitalocean
INFO[0000] digitalocean: creating instance setup-testpool-1655379844  driver=digitalocean hibernate=false image=docker-18-04 pool=testpool
INFO[0001] digitalocean: instance created setup-testpool-1655379844  driver=digitalocean hibernate=false image=docker-18-04 pool=testpool
INFO[0003] digitalocean: firewall configured setup-testpool-1655379844  driver=digitalocean hibernate=false image=docker-18-04 pool=testpool
DEBU[0003] find instance network                         driver=digitalocean hibernate=false image=docker-18-04 name=setup-testpool-1655379844 pool=testpool
DEBU[0063] find instance network                         driver=digitalocean hibernate=false image=docker-18-04 name=setup-testpool-1655379844 pool=testpool
INFO[0064] setup: instance logs for 304473745: no logs here
TRAC[0064] setup: running healthcheck and waiting for an ok response
TRAC[0129] RetryHealth: health check completed           duration=1m5.3480743s
TRAC[0129] LE.RetryHealth check complete                 response="&{Version:0.1.0 DockerInstalled:true GitInstalled:true LiteEngineLog:time=\"2022-06-16T11:45:44Z\" level=info msg=\"server listening at port :9079\"\ntime=\"2022-06-16T11:45:44Z\" level=info msg=\"checking git is installed\"\ntime=\"2022-06-16T11:45:44Z\" level=info msg=\"git is installed\"\ntime=\"2022-06-16T11:45:44Z\" level=info msg=\"checking docker is installed\"\nCONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES\ntime=\"2022-06-16T11:45:44Z\" level=info msg=\"docker is installed\"\ntime=\"2022-06-16T11:45:44Z\" level=info msg=\"handler: HandleHealth()\"\ntime=\"2022-06-16T11:46:13Z\" level=info msg=\"checking docker is installed\"\nCONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES\ntime=\"2022-06-16T11:46:13Z\" level=info msg=\"docker is installed\"\ntime=\"2022-06-16T11:46:13Z\" level=info msg=\"checking git is installed\"\ntime=\"2022-06-16T11:46:13Z\" level=info msg=\"git is installed\"\n OK:true}"
Pool file:
version: "1"
instances:
- name: testpool
  default: true
  type: digitalocean
  pool: 1
  limit: 2
  platform:
    os: linux
    arch: amd64
  spec:
    account:
      pat: XXXXXXXXX

DEBU[0130] deleting droplet                              driver=amazon id="[304473745]"
DEBU[0130] droplet deleted                               driver=amazon id="[304473745]"
TRAC[0130] digitalocean: VM terminated                   driver=amazon id="[304473745]"
```

--------------------------------

### Configure exec runner environment variables

Source: https://docs.drone.io/runner/exec/installation/windows

Example environment variable file for the exec runner. Uses <variable>=value syntax; '#' starts comments. Not a bash file, so bash syntax and expressions are not supported.

```text
DRONE_RPC_PROTO=https
DRONE_RPC_HOST=drone.company.com
DRONE_RPC_SECRET=super-duper-secret

```

--------------------------------

### Promote build 42 to staging

Source: https://docs.drone.io/promote

Example command that promotes build number 42 of octocat/hello-world to the staging environment.

```bash
$ drone build promote octocat/hello-world 42 staging

```

--------------------------------

### Run the Nomad runner container

Source: https://docs.drone.io/runner/nomad/installation

Starts the Nomad runner container with the required environment variables. Replace the example values with your Drone server details. The command mounts the Docker socket and sets DRONE_RPC_PROTO, DRONE_RPC_HOST, DRONE_RPC_SECRET, NOMAD_ADDR, and NOMAD_TOKEN.

```bash
docker run --detach \
  --volume=/var/run/docker.sock:/var/run/docker.sock \
  --env=DRONE_RPC_PROTO=https \
  --env=DRONE_RPC_HOST=drone.company.com \
  --env=DRONE_RPC_SECRET=super-duper-secret \
  --env=NOMAD_ADDR=http://nomad.company.com:4646 \
  --env=NOMAD_TOKEN=super-secret-token \
  --restart=always \
  --name=runner \
  drone/drone-runner-nomad:latest
```

--------------------------------

### Exec pipeline configuration example

Source: https://docs.drone.io/pipeline/exec/overview

Full example of an exec pipeline configuration with kind, type, platform, and steps. The pipeline runs on linux/amd64 and executes a greeting step that echoes 'hello world'.

```yaml
---
kind: pipeline
type: exec
name: default

platform:
  os: linux
  arch: amd64

steps:
- name: greeting
  commands:
  - echo hello world

...
```

--------------------------------

### user_data field in pool.yml

Source: https://docs.drone.io/runner/vm/configuration/cloud-init

Defines a custom cloud-init configuration inline in the `user_data` field of the pool.yml spec. Uses Go template syntax with variables like `.Architecture`, `.CaCertPath`, `.CACert`, `.TLSCert`, `.TLSKey`, `.LiteEnginePath`, and `.Platform`. The cloud-init config installs Docker, writes certificate files, and starts the lite-engine server.

```yaml
version: "1"
instances:
  - name: test_pool
    default: true
    type: amazon
    pool: 1    
    limit: 1 
    platform:
      os: linux
      arch: amd64
    spec:
      account:
        region: us-east-2
        access_key_id: XXXXXXXXXXXXXXXXXXXXX
        access_key_secret: XXXXXXXXXXXXXXXXXXXXX
      ami: ami-051197ce9cbb023ea
      size: t2.micro
      user_data: |
        #cloud-config
        apt:
          sources:
            docker.list:
              source: deb [arch={{ .Architecture }}] https://download.docker.com/linux/ubuntu $RELEASE stable
              keyid: 9DC858229FC7DD38854AE2D88D81803C0EBFCD88
        packages:
        - wget
        - docker-ce
        write_files:
        - path: {{ .CaCertPath }}
          permissions: '0600'
          encoding: b64
          content: {{ .CACert | base64  }}
        - path: {{ .CertPath }}
          permissions: '0600'
          encoding: b64
          content: {{ .TLSCert | base64 }}
        - path: {{ .KeyPath }}
          permissions: '0600'
          encoding: b64
          content: {{ .TLSKey | base64 }}
        runcmd:
        - 'wget "{{ .LiteEnginePath }}/lite-engine-{{ .Platform }}-{{ .Architecture }}" -O /usr/bin/lite-engine'
        - 'chmod 777 /usr/bin/lite-engine'
        - 'touch /root/.env'
        - 'touch /tmp/magic_lives_here'
        - '/usr/bin/lite-engine server --env-file /root/.env > /var/log/lite-engine.log 2>&1 &'
```

--------------------------------

### Correct hostname example (good)

Source: https://docs.drone.io/pipeline/docker/examples/services/postgres

Shows the correct way to connect using the service container name as the hostname.

```yaml
steps:
- name: test
  image: postgres
  commands:
  - sleep 15
  - psql -U postgres -d test -h database

```

--------------------------------

### Install Tmux

Source: https://docs.drone.io/runner/vm/drivers/anka

Installs tmux using Homebrew.

```bash
brew install tmux
```

--------------------------------

### Promote a build by build number

Source: https://docs.drone.io/cli/build/drone-build-promote

Example command that promotes build 42 of octocat/hello-world to the production environment.

```bash
$ drone build promote octocat/hello-world 42 production
```

--------------------------------

### Download Anka

Source: https://docs.drone.io/runner/vm/drivers/anka

Downloads the latest Anka virtualization package and installs it using the macOS installer.

```bash
FULL_FILE_NAME="$(curl -Ls -r 0-1 -o /dev/null -w %{url_effective} https://veertu.com/downloads/anka-virtualization-latest | cut -d/ -f5)"
curl -S -L -o ./$FULL_FILE_NAME https://veertu.com/downloads/anka-virtualization-latest
sudo installer -pkg $FULL_FILE_NAME -tgt /
```

--------------------------------

### drone repo info - show repository details

Source: https://docs.drone.io/cli/repo/drone-repo-info

Prints the named repository details. The example shows output for octocat/hello-world, including owner, repo name, type, private flag, and remote URL.

```bash
$ drone repo info octocat/hello-world

Owner: octocat
Repo: hello-world
Type: git
Private: false
Remote: https://github.com/octocat/hello-world.git

```

--------------------------------

### drone log purge example

Source: https://docs.drone.io/cli/drone-log

Example of purging a log for a specific build, stage, and step.

```text
drone log purge octocat/hello-world 19 1 3
```

--------------------------------

### List Configuration Files

Source: https://docs.drone.io/runner/vm/configuration/pool

Example of listing the contents of a configuration directory containing the pool file and environment variables.

```bash
ls  /path/on/host/config/
.drone_pool.yml
.env
```

--------------------------------

### Example pipeline using Docker and Slack plugins

Source: https://docs.drone.io/plugins/overview

Shows a complete Drone pipeline configuration with three steps: build, publish using the Docker plugin, and notify using the Slack plugin. The settings for each plugin are defined in the step's settings section.

```yaml
kind: pipeline
type: docker
name: default

steps:
- name: build
  image: golang
  commands:
  - go get
  - go test
  - go build

- name: publish
  image: plugins/docker
  settings:
    username: kevinbacon
    password: pa55word
    repo: foo/bar
    tags:
    - 1.0.0
    - 1.0

- name: notify
  image: plugins/slack
  settings:
    channel: developers
    username: drone

```

--------------------------------

### Example plugin configuration

Source: https://docs.drone.io/plugins/overview

Shows a plugin step configuration with settings for the Docker plugin. These settings are passed to the plugin container as environment variables.

```yaml
- name: publish
  image: plugins/docker
  settings:
    username: kevinbacon
    password: pa55word
    repo: foo/bar
    tags:
    - 1.0.0
    - 1.0

```

--------------------------------

### drone cron ls example

Source: https://docs.drone.io/cli/cron/drone-cron-ls

Example invocation of drone cron ls with the repository octocat/hello-world.

```bash
drone cron ls octocat/hello-world

```

--------------------------------

### Start the Drone server container

Source: https://docs.drone.io/server/provider/bitbucket-cloud

Starts the Drone server container with the required environment variables. Replace the placeholder values with your actual Bitbucket OAuth credentials, shared secret, and server host.

```bash
docker run \
  --volume=/var/lib/drone:/data \
  --env=DRONE_BITBUCKET_CLIENT_ID=05136e57d80189bef462 \
  --env=DRONE_BITBUCKET_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e \
  --env=DRONE_RPC_SECRET=super-duper-secret \
  --env=DRONE_SERVER_HOST=drone.company.com \
  --env=DRONE_SERVER_PROTO=https \
  --publish=80:80 \
  --publish=443:443 \
  --restart=always \
  --detach=true \
  --name=drone \
  drone/drone:2

```

--------------------------------

### Start Runner with Pool Configuration

Source: https://docs.drone.io/runner/vm/configuration/pool

Command to start the drone-runner-aws container while mounting the configuration directory.

```bash
docker run -d \
  --volume=/path/on/host/config:/config/ \
  --publish=3000:3000 \
  --restart always \
  --name runner \
  drone/drone-runner-aws /config/.env /config/pool.yml
```

--------------------------------

### Download macOS Installer ISO

Source: https://docs.drone.io/runner/vm/drivers/anka

Lists available full macOS installers using the softwareupdate command.

```bash
softwareupdate --list-full-installers
```

--------------------------------

### Example environment file with DRONE_RPC settings

Source: https://docs.drone.io/runner/exec/installation/linux

Example environment file showing required configuration options: protocol, host, and secret. This file uses `<variable>=value` syntax and `#` for comments; it is not a bash file so bash syntax and expressions are not supported.

```bash
DRONE_RPC_PROTO=https
DRONE_RPC_HOST=drone.company.com
DRONE_RPC_SECRET=super-duper-secret
```

--------------------------------

### drone secret rm example

Source: https://docs.drone.io/cli/secret/drone-secret-rm

Example command that removes the secret named 'token' from the repository 'octocat/hello-world'.

```bash
$ drone secret rm octocat/hello-world token
```

--------------------------------

### Using plugins to integrate with third-party systems

Source: https://docs.drone.io/quickstart/docker

Shows how to use plugins to integrate with third-party systems. The example uses the Slack plugin to send a notification after a test step.

```yaml
kind: pipeline
type: docker
name: default

steps:
- name: test
  image: golang:1.13
  commands:
  - go build
  - go test -v

- name: notify
  image: plugins/slack
  settings:
    channel: dev
    webhook: https://hooks.slack.com/services/...

```

--------------------------------

### drone orgsecret rm example

Source: https://docs.drone.io/cli/orgsecret/drone-orgsecret-rm

Example invocation that removes the secret named 'my_token' from the organization 'acme'.

```bash
$ drone orgsecret rm acme my_token
```

--------------------------------

### Slack plugin example

Source: https://docs.drone.io/pipeline/docker/syntax/plugins

Shows a complete Drone pipeline with a build step and a Slack notification step using the plugins/slack image.

```yaml
kind: pipeline
type: docker
name: default

steps:
- name: build
  image: node
  commands:
  - npm install
  - npm test

- name: notify
  image: plugins/slack
  settings:
    webhook: https://hooks.slack.com/services/...

```

--------------------------------

### drone cron disable example

Source: https://docs.drone.io/cli/cron/drone-cron-disable

Example command that disables the 'nightly' cron job in the 'octocat/hello-world' repository.

```bash
drone cron disable octocat/hello-world nightly

```

--------------------------------

### Correct hostname example (using redis)

Source: https://docs.drone.io/pipeline/docker/examples/services/redis

Shows the correct configuration using the service container name 'redis' as the hostname.

```yaml
steps:
- name: test
  image: redis
  commands:
  - sleep 15
  - redis-cli -h redis ping

```

--------------------------------

### Docker pipeline configuration example

Source: https://docs.drone.io/pipeline/docker/overview

Full example of a Docker pipeline configuration with kind, type, name, and a single step that builds and tests a Go project. The step runs in a golang:1.12 container.

```yaml
---
kind: pipeline
type: docker
name: default

steps:
- name: greeting
  image: golang:1.12
  commands:
  - go build
  - go test

...
```

--------------------------------

### Start Runner with Tmux

Source: https://docs.drone.io/runner/vm/drivers/anka

Starts the Drone runner daemon in a tmux session, logging output to runner.log.

```bash
tmux new -d './drone-runner-aws daemon --envfile=.env --pool=pool.yml |& tee runner.log'
```

--------------------------------

### Example with labels

Source: https://docs.drone.io/pipeline/kubernetes/syntax/metadata

Example configuration that adds labels to the pipeline metadata. The labels are key-value pairs under the metadata section.

```yaml
kind: pipeline
type: kubernetes
name: default

metadata:
  namespace: default
  labels:
    key1: value1
    key2: value2

```

--------------------------------

### Set up Anka using drone-runner-aws setup --anka-vm-name

Source: https://docs.drone.io/runner/vm/configuration/setup

Runs the setup command for Anka, passing the VM name to use as the master VM. The command requires the --anka-vm-name flag (here 'master-vm') and produces a pool file with the 'testpool' instance, which defaults to type 'anka', uses the macOS platform, and sets vm_id to master-vm. The log output shows retries until the VM's IP is discovered, then instance creation and pool file contents.

```shell
./drone-runner-aws setup --anka-vm-name master-vm
```

```text
INFO[0000] setup: using anka
INFO[0000] no pool file provided
DEBU[0003] Not there yet 1/60, error: exit status 2
DEBU[0007] Not there yet 2/60, error: exit status 2
DEBU[0011] Not there yet 3/60, error: exit status 2
DEBU[0013] Not there yet 4/60, error: exit status 2q
DEBU[0016] got IP 192.168.64.32                          cloud=anka name=setup--5577006791947779410 pool=testpool
INFO[0017] Running script in VM                          cloud=anka name=setup--5577006791947779410 pool=testpool
DEBU[0273] anka: [creation] complete                     cloud=anka fields.time=273.27s ip=192.168.64.32 name=setup--5577006791947779410 pool=testpool
INFO[0273] setup: instance logs for da894645-10c1-460f-886f-df6d65677c52:
Pool file:
version: "1"
instances:
- name: testpool
  default: true
  type: anka
  pool: 1
  limit: 2
  platform:
    os: darwin
    arch: amd64
    spec:
    account:
      username: ""
      password: ""
    vm_id: master-vm
    root_directory: ""
    user_data: ""
```

--------------------------------

### Example with annotations

Source: https://docs.drone.io/pipeline/kubernetes/syntax/metadata

Example configuration that adds annotations to the pipeline metadata. The annotations are key-value pairs under the metadata section.

```yaml
kind: pipeline
type: kubernetes
name: default

metadata:
  namespace: default
  annotations:
    key1: value1
    key2: value2

```

--------------------------------

### Example usage: drone build ls octocat/hello-world

Source: https://docs.drone.io/cli/build/drone-build-ls

Shows a basic invocation of the drone build ls subcommand with a repository name. The command lists recent builds for the specified repository.

```bash
$ drone build ls octocat/hello-world
```

--------------------------------

### Start Drone server container

Source: https://docs.drone.io/server/provider/gitea

Runs the Drone server container with required environment variables for Gitea integration. Configure DRONE_GITEA_SERVER, DRONE_GITEA_CLIENT_ID, DRONE_GITEA_CLIENT_SECRET, DRONE_RPC_SECRET, DRONE_SERVER_HOST, and DRONE_SERVER_PROTO.

```bash
docker run \
  --volume=/var/lib/drone:/data \
  --env=DRONE_GITEA_SERVER=https://try.gitea.io \
  --env=DRONE_GITEA_CLIENT_ID=05136e57d80189bef462 \
  --env=DRONE_GITEA_CLIENT_SECRET=7c229228a77d2cbddaa61ddc78d45e \
  --env=DRONE_RPC_SECRET=super-duper-secret \
  --env=DRONE_SERVER_HOST=drone.company.com \
  --env=DRONE_SERVER_PROTO=https \
  --publish=80:80 \
  --publish=443:443 \
  --restart=always \
  --detach=true \
  --name=drone \
  drone/drone:2

```

--------------------------------

### Example policy file

Source: https://docs.drone.io/runner/kubernetes/configuration/policies

Defines two policies: 'octocat' with a repo match and metadata namespace, and 'default' with only metadata namespace. The first matching policy is applied.

```yaml
---
kind: policy
name: octocat

match:
  repo:
  - "octocat/*"
  - "octocat/hello-world"

metadata:
  namespace: octocat

resources:
  request:
    cpu: 1000
    memory: 512MiB
  limit:
    cpu: 4000
    memory: 1GiB

node_selector:
  disktype: ssd

---
kind: policy
name: default

metadata:
  namespace: default

```

--------------------------------

### Step commands example

Source: https://docs.drone.io/pipeline/aws/syntax/steps

Shows a single step with commands. Commands are executed in the workspace root.

```yaml
steps:
- name: backend
  image: golang
  commands:
  - go build
  - go test

```

--------------------------------

### Slack plugin step

Source: https://docs.drone.io/pipeline/aws/syntax/steps

Example of using a plugin (plugins/slack) with settings.

```yaml
- name: notify
  image: plugins/slack
  settings:
    webhook: https://hooks.slack.com/services/...

```

--------------------------------

### Install Drone CLI on Windows via Scoop

Source: https://docs.drone.io/cli

Installs the Drone CLI on Windows using the Scoop package manager.

```powershell
$ scoop install drone

```
Tokens:
Raw