diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index a15da9f1..507e88ae 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -1,33 +1,33 @@ ## Run as a Bitbucket Pipeline - You can use the Bitbucket Pipeline system to run PR-Agent on every pull request open or update. 1. Add the following file in your repository bitbucket-pipelines.yml ```yaml pipelines: - pull-requests: - '**': - - step: - name: PR Agent Review - image: python:3.12 - services: - - docker - script: - - docker run -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=https://bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG/pull-requests/$BITBUCKET_PR_ID review + pull-requests: + "**": + - step: + name: PR Agent Review + image: python:3.12 + services: + - docker + script: + - docker run -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=https://bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG/pull-requests/$BITBUCKET_PR_ID review ``` 2. Add the following secure variables to your repository under Repository settings > Pipelines > Repository variables. -OPENAI_API_KEY: `` -BITBUCKET_BEARER_TOKEN: `` + OPENAI_API_KEY: `` + BITBUCKET.AUTH_TYPE: `basic` or `bearer` (default is `bearer`) + BITBUCKET.BEARER_TOKEN: `` (required when auth_type is bearer) + BITBUCKET.BASIC_TOKEN: `` (required when auth_type is basic) You can get a Bitbucket token for your repository by following Repository Settings -> Security -> Access Tokens. +For basic auth, you can generate a base64 encoded token from your username:password combination. Note that comments on a PR are not supported in Bitbucket Pipeline. - - ## Bitbucket Server and Data Center Login into your on-prem instance of Bitbucket with your service account username and password. @@ -48,6 +48,7 @@ git_provider="bitbucket_server" ``` and pass the Pull request URL: + ```shell python cli.py --pr_url https://git.onpreminstanceofbitbucket.com/projects/PROJECT/repos/REPO/pull-requests/1 review ``` @@ -55,6 +56,7 @@ python cli.py --pr_url https://git.onpreminstanceofbitbucket.com/projects/PROJEC ### Run it as service To run PR-Agent as webhook, build the docker image: + ``` docker build . -t codiumai/pr-agent:bitbucket_server_webhook --target bitbucket_server_webhook -f docker/Dockerfile docker push codiumai/pr-agent:bitbucket_server_webhook # Push to your Docker repository