Bitbucket Cloud

https://support.atlassian.com/bitbucket-cloud/docs/
Admin
Bitbucket Cloud is a Git repository hosting and collaboration platform that enables teams to manage...
Tokens:570,550
Snippets:4,944
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example bitbucket-pipelines.yml

Source: https://support.atlassian.com/bitbucket-cloud/docs/publish-and-link-your-build-artifacts

Example bitbucket-pipelines.yml file that combines all steps: installing dependencies, running tests, uploading documentation to S3, and linking the artifact to the build via the REST API. Adjust parameters and ensure all required variables are defined.

```yaml
image: python:3.5.1
pipelines:
  branches:
    main:
      - step:
          script:
            - pip install boto3==1.3.0   # required for s3_upload.py
            - python run_tests.py
            - python s3_upload.py "${S3_BUCKET}" documentation.html "${S3_KEY_PREFIX}_${BITBUCKET_COMMIT}"   # upload docs to S3
            - export S3_URL="https://${S3_BUCKET}.s3.amazonaws.com/"${S3_KEY_PREFIX}_${BITBUCKET_COMMIT}"
            - export BUILD_STATUS="{\"key\":\"doc\", \"state\":\"SUCCESSFUL\", \"name\":\"Documentation\", \"url\":\"${S3_URL}\"}"
            - curl -H "Content-Type:application/json" -X POST --user "${ATLASSIAN_ACCOUNT_EMAIL}:{$ATLASSIAN_API_TOKEN}" -d "${BUILD_STATUS}" "https://api.bitbucket.org/2.0/repositories/${BITBUCKET_REPO_OWNER}/${BITBUCKET_REPO_SLUG}/commit/${BITBUCKET_COMMIT}/statuses/build"
```

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

### WebdriverIO bitbucket-pipelines.yaml example

Source: https://support.atlassian.com/bitbucket-cloud/docs/test-reporting-in-pipelines

Example pipeline configuration for running WebdriverIO tests with npm install and npm test.

```yaml
pipelines:
  default:
    - step:
        name: Build and Test
        caches:
          - node
        script:
          - npm install
          - npm test
```

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

### Install gd extension with docker-php-ext

Source: https://support.atlassian.com/bitbucket-cloud/docs/php-with-bitbucket-pipelines

Installs the gd extension using helper scripts. First installs required libraries, then configures and installs the extension.

```yaml
image: php:7.1.1
pipelines:
  default:
    - step:
        script:
          # Installing first the libraries necessary to configure and install gd
          - apt-get update && apt-get install -y libfreetype6-dev libjpeg62-turbo-dev libpng12-dev
          # Now we can configure and install the extension
          - docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/
          - docker-php-ext-install -j$(nproc) gd
```

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

### Install dependencies with bundle install

Source: https://support.atlassian.com/bitbucket-cloud/docs/ruby-with-bitbucket-pipelines

Use this configuration to install all dependencies from a Gemfile at the start of your pipeline script.

```yaml
image: ruby:2.4.0
pipelines:
  default:
    - step:
        script:
          - bundle install
```

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

### Create a directory for repositories

Source: https://support.atlassian.com/bitbucket-cloud/docs/copy-your-git-repository-and-add-files

Create a directory named 'repos' to contain all your repositories.

```bash
$ mkdir repos
```

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

### Basic stage setup with name and steps

Source: https://support.atlassian.com/bitbucket-cloud/docs/stages

Adds a stage with a name and groups two steps (build and test) under it. Use this to organize pipeline steps with shared properties.

```yaml
pipelines:
    default:
     - stage:
         name: Build and test
         steps:
           - step:
               name: Build app
               script:
                 - sh ./build-app.sh
           - step:
               name: Run unit tests
               script:
                 - sh ./run-tests.sh
```

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

### GET group privileges example

Source: https://support.atlassian.com/bitbucket-cloud/docs/group-privileges-endpoint

Example call for the GET method. It locates each repository owned by mcatalbas to which the group mcatalbas/designers has some level of access and lists the group's privileges in that repository.

```text
https://api.bitbucket.org/1.0/group-privileges/api/1.0/group-privileges/mcatalbas/mcatalbas/designers
```

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

### NUnit bitbucket-pipelines.yaml example

Source: https://support.atlassian.com/bitbucket-cloud/docs/test-reporting-in-pipelines

Example pipeline configuration for building and testing a .NET solution with JUnit XML output.

```yaml
pipelines:
  default:
    - step:
        name: Build and Test
        caches:
          - dotnetcore
        script:
          - echo "Restoring NuGet packages..."
          - dotnet restore
          - echo "Building solution..."
          - dotnet build --configuration Release --no-restore
          - echo "Running tests with JUnit XML output..."
          - mkdir -p TestResults test-reports test-results
          - dotnet test --configuration Release --no-build --logger "junit;LogFilePath=TestResults/test-results.xml"
```

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

### Increase memory allocation for service not starting

Source: https://support.atlassian.com/bitbucket-cloud/docs/databases-and-service-containers

If a service fails to start, increase its memory allocation. This example sets postgres memory to 2048 MB.

```yaml
definitions:
  services:
    postgres:
      memory: 2048
```

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

### Install dependencies with apt-get in bitbucket-pipelines.yml

Source: https://support.atlassian.com/bitbucket-cloud/docs/specify-dependencies-in-your-pipelines-build

Use apt-get in the build script of a Debian-based Docker image to install dependencies. This example targets the Maven 3.3.9 image and installs imagemagick and libjmagick6-java before building the Java app with Maven.

```yaml
image: maven:3.3.9
pipelines:
  default:
    - step:
        script:
          # install deps
          - apt-get update && apt-get install -y imagemagick libjmagick6-java
          # build the Java app
          - mvn package
```

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

### Deployment example: set deployment environment for a step

Source: https://support.atlassian.com/bitbucket-cloud/docs/stages

Shows a step that sets the deployment environment to `production env 1` and runs a Python deployment script.

```yaml
pipelines:
  default:
    - step:
        name: Deploy to production
        deployment: production env 1
        script:
          - python deploy.py prod_env_1
```

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

### List issues on tutorial repository

Source: https://support.atlassian.com/bitbucket-cloud/docs/oauth-endpoints

Lists all issues on Bitbucket's tutorial repository using the 2.0 API repositories endpoint.

```bash
curl https://api.bitbucket.org/2.0/repositories/tutorials/tutorials.bitbucket.org
```

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

### Install dependencies from requirements.txt in Bitbucket Pipelines

Source: https://support.atlassian.com/bitbucket-cloud/docs/python-with-bitbucket-pipelines

Installs all dependencies listed in a requirements.txt file at the start of a pipeline step. Requires a Python 3.7.2 image and a requirements.txt file in the repository.

```yaml
image: python:3.7.2
pipelines:
  default:
    - step:
        script:
          - pip install -r requirements.txt
```

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

### Configure SSH agent to start automatically (Windows OpenSSH)

Source: https://support.atlassian.com/bitbucket-cloud/docs/set-up-project-access-keys-on-windows

Use the Set-Service command to configure the SSH agent to start each time the device starts. Note: The example uses -Name sshd, but the service name for the SSH agent is typically ssh-agent.

```powershell
> Set-Service -Name sshd -StartupType 'Automatic'
```

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

### Deployment example: set deployment environment for stages

Source: https://support.atlassian.com/bitbucket-cloud/docs/stages

Shows two stages: the first sets deployment to `staging` and runs build and test steps; the second sets deployment to `prod` with a manual trigger and runs build and test steps.

```yaml
pipelines:
   default:
    - stage:
        name: Build and test
        deployment: staging
        steps:
          - step:
              name: Build app
              script:
                - sh ./build-app.sh
          - step:
              name: Run unit tests
              script:
                - sh ./run-tests.sh
    - stage:
        name: Deploy to Production
        deployment: prod
        trigger: manual
        steps:
          - step:
              name: Build app
              script:
                - sh ./build-app.sh
          - step:
              name: Run unit tests
              script:
                - sh ./run-tests.sh
```

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

### Run PHPUnit tests with composer install in bitbucket-pipelines.yml

Source: https://support.atlassian.com/bitbucket-cloud/docs/php-with-bitbucket-pipelines

Use this bitbucket-pipelines.yml example to run PHPUnit tests with Composer when your repository contains a composer.json file that declares the PHPUnit dependency. The script installs unzip and Composer, runs composer install, and then executes vendor/bin/phpunit.

```yaml
image: php:7.1.1
pipelines:
  default:
    - step:
        script:
          - apt-get update && apt-get install -y unzip
          - curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
          - composer install
          - vendor/bin/phpunit
```

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

### Deploy artifacts with bitbucket-upload-file pipe

Source: https://support.atlassian.com/bitbucket-cloud/docs/deploy-build-artifacts-to-bitbucket-downloads

Place this bitbucket-pipelines.yml at the root of your repository. It creates a hello world Go app, builds it, and uploads the compiled binary to Bitbucket Downloads using the bitbucket-upload-file pipe (version 0.7.5). Requires ATLASSIAN_ACCOUNT_EMAIL and ATLASSIAN_API_TOKEN repository variables.

```yaml
image: golang:1.25.0
pipelines:
  default:
    - step:
        name: Create hello world go app
        artifacts:
          - main.go
        script:
          - |
            cat > main.go << 'EOF'
            package main
            func main() { println("Hello, World!") }
            EOF
    - step:
        name: Build
        artifacts:
          - compiled_app
        script:
          - go build -o compiled_app main.go
    - step:
        name: Upload
        script:
          - pipe: atlassian/bitbucket-upload-file:0.7.5
            variables:
              ATLASSIAN_ACCOUNT_EMAIL: $ATLASSIAN_ACCOUNT_EMAIL
              ATLASSIAN_API_TOKEN: $ATLASSIAN_API_TOKEN
              FILENAME: "compiled_app"
```

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

### Complete Pipeline Example: Build, Test, Deploy

Source: https://support.atlassian.com/bitbucket-cloud/docs/variable-sharing

A full Bitbucket Pipelines configuration that builds a Node.js project, tests it, and deploys to staging. It demonstrates writing variables to `$BITBUCKET_PIPELINES_VARIABLES_PATH` and using them in subsequent steps.

```yaml
image: node:20
pipelines:
  default:
    - step:
        name: Build
        script:
          - npm ci
          - npm run build
          - export ARTIFACT=$(ls dist/*.tar.gz | head -1)
          - echo "ARTIFACT=$ARTIFACT" >> $BITBUCKET_PIPELINES_VARIABLES_PATH
          - echo "BUILD_TIME=$(date -u +%Y-%m-%dT%H:%M:%SZ)" >> $BITBUCKET_PIPELINES_VARIABLES_PATH
        output-variables:
          - ARTIFACT
          - BUILD_TIME
        artifacts:
          - dist/**
    - step:
        name: Test
        script:
          - echo "Testing artifact: $ARTIFACT"
          - npm test
    - step:
        name: Deploy to Staging
        deployment: staging
        script:
          - echo "Deploying $ARTIFACT (built at $BUILD_TIME)"
          - ./deploy.sh $ARTIFACT staging
```

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

### GET /1.0/group-privileges/{accountname}/

Source: https://support.atlassian.com/bitbucket-cloud/docs/group-privileges-endpoint

Examples of using the group-privileges resource with filter and private query parameters.

```APIDOC
## GET /1.0/group-privileges/{accountname}/?filter=admin

### Description
Retrieves group privileges for a specified account, optionally filtered by privilege level (read, write, admin).

### Method
GET

### Endpoint
/1.0/group-privileges/{accountname}/?filter=admin

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Limits results to a specific privilege level: read, write, or admin.

### Request Example
curl --request GET --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/?filter=admin

### Response
#### Success Response (200)
- **repo** (string) - The owner and name of the repository in the form owner/repository.
- **privilege** (string) - The privilege associated with the group.
- **group** (object) - The profile associated with the group.
- **repository** (object) - The repository to which the group has access.

#### Response Example
{
  "repo": "1team/justdirectteam",
  "privilege": "admin",
  "group": {
    "owner": {
      "display_name": "1team",
      "uuid": "{c423e13e-b541-3e77-b363-3e0b458u8226}",
      "is_team": true,
      "mention_id": null,
      "avatar": "https://secure.gravatar.com/avatar/12e5043.png",
      "nickname": "1team",
      "account_id": null
    },
    "name": "Administrators",
    "members": [
      {
        "display_name": "Justen Stepka",
        "uuid": "{c423e13e-b541-3e77-b363-3e0b458u8226}",
        "is_team": false,
        "avatar": "https://secure.gravatar.com/avatar/12e5043",
        "nickname": "jstepka",
        "account_id": "557057:016ad873-3455-3455-23443-233534545434"
      }
    ],
    "slug": "administrators"
  },
  "repository": {
    "owner": {
      "display_name": "Justen Stepka",
      "uuid": "{b8441b1d-a5e6-480a-ba0b-fde829182e4a}",
      "is_team": true,
      "mention_id": null,
      "avatar": "https://secure.gravatar.com/avatar/12e5043",
      "nickname": "supertesterteam",
      "account_id": null
    },
    "name": "justdirectteam",
    "slug": "justdirectteam"
  }
}
```

```APIDOC
## GET /1.0/group-privileges/{accountname}/?private=true

### Description
Retrieves group privileges for a specified account, optionally filtered to private repositories only.

### Method
GET

### Endpoint
/1.0/group-privileges/{accountname}/?private=true

### Parameters
#### Query Parameters
- **private** (boolean) - Optional - When set to true, filters results to private repositories.

### Request Example
curl --request GET --user mcatalbas:password https://api.bitbucket.org/1.0/group-privileges/mcatalbas/?private=true

### Response
#### Success Response (200)
- **repo** (string) - The owner and name of the repository in the form owner/repository.
- **privilege** (string) - The privilege associated with the group.
- **group** (object) - The profile associated with the group.
- **repository** (object) - The repository to which the group has access.

#### Response Example
{
  "repo": "1team/justdirectteam",
  "privilege": "admin",
  "group": {
    "owner": {
      "display_name": "1team",
      "uuid": "{c423e13e-b541-3e77-b363-3e0b458u8226}",
      "is_team": true,
      "mention_id": null,
      "avatar": "https://secure.gravatar.com/avatar/12e5043.png",
      "nickname": "1team",
      "account_id": null
    },
    "name": "Administrators",
    "members": [
      {
        "display_name": "Justen Stepka",
        "uuid": "{c423e13e-b541-3e77-b363-3e0b458u8226}",
        "is_team": false,
        "avatar": "https://secure.gravatar.com/avatar/12e5043",
        "nickname": "jstepka",
        "account_id": "557057:016ad873-3455-3455-23443-233534545434"
      }
    ],
    "slug": "administrators"
  },
  "repository": {
    "owner": {
      "display_name": "Justen Stepka",
      "uuid": "{b8441b1d-a5e6-480a-ba0b-fde829182e4a}",
      "is_team": true,
      "mention_id": null,
      "avatar": "https://secure.gravatar.com/avatar/12e5043",
      "nickname": "supertesterteam",
      "account_id": null
    },
    "name": "justdirectteam",
    "slug": "justdirectteam"
  }
}
```

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

### Example — using the steps property to list the steps in a stage

Source: https://support.atlassian.com/bitbucket-cloud/docs/parallel-step-options

Shows a pipeline with a stage named 'Build and test' that contains two steps: one to build the app and one to run unit tests. The steps property lists the steps within the stage.

```yaml
pipelines:
   default:
    - stage:
        name: Build and test
        steps:
          - step:
              name: Build app
              script:
                - sh ./build-app.sh
          - step:
              name: Run unit tests
              script:
                - sh ./run-tests.sh
```

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

### Use multiple caches in a step

Source: https://support.atlassian.com/bitbucket-cloud/docs/cache-dependencies

Use multiple caches in a single step. The example lists node, docker, and composer caches and runs npm install, composer install, and docker build.

```yaml
pipelines:
  default:
    - step:
        caches:
          - node
          - docker
          - composer
        script:
          - npm install
          - composer install
          - docker build -t myapp .
```

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

### Bitbucket Pipelines YAML: Parallel steps example

Source: https://support.atlassian.com/bitbucket-cloud/docs/set-up-or-run-parallel-steps

Example pipeline configuration showing a non-parallel build step, two parallel testing steps, and a final non-parallel deploy step. Use this to run independent steps concurrently and reduce build time.

```yaml
pipelines:
  default:
    - step:          # non-parallel step
        script:
          - ./build.sh
    - parallel:      # these 2 steps will run in parallel
        steps:
          - step:
              script:
                - ./integration-tests.sh --batch 1
          - step:
              script:
                - ./integration-tests.sh --batch 2
    - step:          # non-parallel step
        script:
          - ./deploy.sh
```

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

### GET /2.0/repositories/{username}/{slug}/refs/

Source: https://support.atlassian.com/bitbucket-cloud/docs/oauth-endpoints

Find all branches with a name starting with "erik/".

```APIDOC
## GET /2.0/repositories/{username}/{slug}/refs/

### Description
Find all branches with a name starting with "erik/".

### Method
GET

### Endpoint
/2.0/repositories/{username}/{slug}/refs/

### Parameters
#### Path Parameters
- **username** (string) - Required - The username or workspace.
- **slug** (string) - Required - The repository slug.

#### Query Parameters
- **q** (string) - Required - Query string: `name ~ "erik/"`

### Request Example
```
/2.0/repositories/{username}/{slug}/refs/?q=name+%7E+%22erik%2F%22
```

### Response
#### Success Response (200)
Returns a paginated list of branches matching the query.

```

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

### Complete testing example with PostgreSQL and Redis

Source: https://support.atlassian.com/bitbucket-cloud/docs/databases-and-service-containers

A full Bitbucket Pipelines configuration for testing with PostgreSQL and Redis services. Includes memory allocation, environment variables, wait loops, and parallel steps for unit and integration tests.

```yaml
image: node:18
definitions:
  services:
    postgres:
      image: postgres:15
      memory: 1024
      variables:
        POSTGRES_DB: myapp_test
        POSTGRES_USER: testuser
        POSTGRES_PASSWORD: testpass
    redis:
      image: redis:7
      memory: 512
options:
  max-time: 30
pipelines:
  default:
    - step:
        name: Lint and Unit Tests
        caches:
          - node
        script:
          - npm install
          - npm run lint
          - npm run test:unit
  branches:
    main:
      - parallel:
          - step:
              name: Unit Tests
              caches:
                - node
              script:
                - npm install
                - npm run test:unit
          - step:
              name: Integration Tests
              size: 2x
              caches:
                - node
              services:
                - postgres
                - redis
              script:
                - npm install
                # Wait for services
                - |
                  until PGPASSWORD=testpass psql -h 127.0.0.1 -U testuser -d myapp_test -c "SELECT 1" > /dev/null 2>&1; do
                    echo "Waiting for PostgreSQL..."
                    sleep 2
                  done
                - |
                  until redis-cli -h 127.0.0.1 ping | grep -q PONG; do
                    echo "Waiting for Redis..."
                    sleep 2
                  done
                # Set environment
                - export DATABASE_URL=postgresql://testuser:testpass@127.0.0.1:5432/myapp_test
                - export REDIS_URL=redis://127.0.0.1:6379
                # Run migrations and tests
                - npm run db:migrate
                - npm run test:integration
              artifacts:
                - test-results/**
  pull-requests:
    '**':
      - step:
          name: PR Tests
          size: 2x
          caches:
            - node
          services:
            - postgres
            - redis
          script:
            - npm install
            - npm run lint
            - npm test
```

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

### Example — using the parallel option to run two steps at the same time

Source: https://support.atlassian.com/bitbucket-cloud/docs/parallel-step-options

Shows a pipeline with two sequential build steps, followed by a parallel group containing two integration test steps, and a final non-parallel deploy step. The parallel group runs the two integration steps concurrently.

```yaml
pipelines:
  default:
    - step: # sequential step
        name: Build
        script:
          - ./build.sh
    - step: # sequential step
        name: Build
        script:
          - ./build.sh
    - parallel: # these 2 steps will run in parallel
        steps:
          - step:
              name: Integration 1
              script:
                - ./integration-tests.sh --batch 1
          - step:
              name: Integration 2
              script:
                - ./integration-tests.sh --batch 2
    - step:  # non-parallel step
        script:
          - ./deploy.sh
```

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

### GET /users/{username} - Partial Response Example

Source: https://support.atlassian.com/bitbucket-cloud/docs/oauth-endpoints

Demonstrates the use of the `fields` query parameter to request partial responses from Bitbucket Cloud API endpoints. The example shows how to remove the `links` field from a user resource response.

```APIDOC
## GET /users/{username}

### Description
Retrieves a user object with the specified username. By default, the full representation of the user resource is returned, including a substantial list of links to related resources. The `fields` query parameter can be used to request a partial response, omitting unwanted data for better performance.

### Method
GET

### Endpoint
https://api.bitbucket.org/2.0/users/{username}

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user to retrieve.

#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of field names to include or exclude from the response. Use `-field` to remove a field, `+field` to add a field not normally returned, or a list of field names to include only those fields. Wildcards (`*`) can be used to match all fields on a level. The `+` must be URL-encoded as `%2B`.

### Request Example
```
$ curl https://api.bitbucket.org/2.0/users/evzijst?fields=-links
```

### Response
#### Success Response (200)
Returns the user object with the requested fields. When using `fields=-links`, the `links` field is omitted.

#### Response Example
```json
{
  "nickname": "evzijst",
  "account_status": "active",
  "website": "",
  "display_name": "Erik van Zijst",
  "uuid": "{a288a0ab-e13b-43f0-a689-c4ef0a249875}",
  "created_on": "2010-07-07T05:16:36+00:00",
  "location": null,
  "type": "user"
}
```
```

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

### Example: using the steps property to list the steps in a parallel group

Source: https://support.atlassian.com/bitbucket-cloud/docs/stages

Shows a pipeline with sequential steps, a parallel group with two integration test steps, and a final non-parallel deploy step. Demonstrates the steps property within a parallel group.

```yaml
pipelines:
   default:
     - step: # sequential step
         name: Build
         script:
           - ./build.sh
     - step: # sequential step
         name: Build
         script:
           - ./build.sh
     - parallel: # these 2 steps will run in parallel
         steps:
           - step:
               name: Integration 1
               script:
                 - ./integration-tests.sh --batch 1
           - step:
               name: Integration 2
               script:
                 - ./integration-tests.sh --batch 2
     - step:  # non-parallel step
         script:
           - ./deploy.sh
```

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

### bitbucket-pipelines.yml configuration for Laravel

Source: https://support.atlassian.com/bitbucket-cloud/docs/laravel-with-bitbucket-pipelines

Defines a default pipeline that uses the php:7.2-fpm Docker image, installs dependencies and PHP extensions, installs Composer, runs migrations, starts the app, and runs PHPUnit. It also defines a MySQL service with the specified environment variables.

```yaml
image: php:7.2-fpm
pipelines:
  default:
    - step:
        script:
          - apt-get update && apt-get install -qy git curl libmcrypt-dev mysql-client
          - yes | pecl install mcrypt-1.0.1
          - docker-php-ext-install pdo_mysql
          - curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
          - composer install
          - ln -f -s .env.pipelines .env
          - php artisan migrate
          - php artisan serve &
          - sleep 5
          - ./vendor/bin/phpunit
          - curl -vk http://localhost:8000
        services:
          - mysql
definitions:
  services:
    mysql:
      image: mysql:5.7
      environment:
        MYSQL_DATABASE: 'homestead'
        MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
        MYSQL_USER: 'homestead'
        MYSQL_PASSWORD: 'secret'
```

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

### GET /repositories/{workspace}/{repo_slug} - URL Encoding Example

Source: https://support.atlassian.com/bitbucket-cloud/docs/oauth-endpoints

Demonstrates the use of URL encoding for the `fields` parameter when including additional fields with the `+` syntax.

```APIDOC
## GET /repositories/{workspace}/{repo_slug}

### Description
Retrieves a repository object. This example demonstrates the use of the `fields` parameter with URL encoding to include additional fields. The `+` in `+owner.created_on` must be URL-encoded as `%2B` to be interpreted correctly.

### Method
GET

### Endpoint
https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}

### Parameters
#### Path Parameters
- **workspace** (string) - Required - The workspace ID or slug.
- **repo_slug** (string) - Required - The repository slug.

#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of field names. Use `%2Bowner.created_on` to include the `created_on` field of the embedded `owner` object.

### Request Example
```
https://api.bitbucket.org/2.0/repositories/evzijst/interruptingcow?fields=%2Bowner.created_on
```

### Response
#### Success Response (200)
Returns the repository object with the additional `owner.created_on` field included.
```

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

### Install a PyPI package with Poetry

Source: https://support.atlassian.com/bitbucket-cloud/docs/working-with-the-pypi-registry

Run this command to install a package using Poetry from the configured Bitbucket source.

```bash
poetry add --source bitbucket <package-name>==<package-version>
```

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

### test.bats example for a bash demo pipe

Source: https://support.atlassian.com/bitbucket-cloud/docs/write-a-pipe-for-bitbucket-pipelines

Example test.bats file using bats (Bash Automated Testing System) to test a Docker container with a NAME variable. It builds the image in setup, runs a dummy test that checks the exit status, and includes teardown. This is from the bash demo pipe.

```bash
#!/usr/bin/env bats  setup() {   DOCKER_IMAGE=${DOCKER_IMAGE:="test/demo-pipe-bash"}    echo "Building image..."   run docker build -t ${DOCKER_IMAGE} . }  teardown() {     echo "Teardown happens after each test." }  @test "Dummy test" {     run docker run \         -e NAME="baz" \         -v $(pwd):$(pwd) \         -w $(pwd) \         ${DOCKER_IMAGE}      echo "Status: $status"     echo "Output: $output"      [ "$status" -eq 0 ] }
```
Tokens:
Raw