endemics/bbc-comment-pipe repository overview

⁠Bitbucket Pipeline Pipe: Comment

This Bitbucket pipeline pipe allow you to publish content generated in your bitbucket pipeline as a comment to the Pull Request that triggered the build.

Usage example of this pipe include publishing a comment containing a list of changes that would be caused by a merge of a Pull Request. This is particularily valuable for repositories containing configuration for an Infrastructure as Code solution such as Terraform⁠ or CloudFormation⁠.

In that case, the list of changes would be created as an artifact of the build as a text file (Markdown syntax is supported), and the pipe would be configured to publish that text file as a comment on each build of the Pull Request.

⁠Prerequisites

A bitbucket account to be used to publish the comment. It is recommended to create an Application Password⁠ dedicated to the pipe in order to limit the privileges. The Pull Request: write permissions is needed.

⁠Usage

To publish a comment to all Pull Requests, add the following snippet to the script section of your bitbucket-pipelines.yml file:

pipelines:
  pull-requests:
    '**':
    - step:
        services:
        - docker
        script:
          - pipe: docker://endemics/bbc-comment-pipe:latest
            variables:
              BB_USER: $BB_USER
              BB_APP_KEY: $BB_APP_KEY
              FILE: "./artifact/comment.md"

⁠Variables

(*) = required variable.

Variables that should automatically be set by Bitbucket pipeline

(*) = required variable.