Skip to content

EkLine Bitbucket integration guide

  1. An EkLine integration token. Get it from Settings > Organization > Access in the EkLine dashboard.
  2. A Bitbucket account with permission to set up pipelines.

Create a file named bitbucket-pipelines.yml in your project root, with this content:

runEkLineStep: &runEkLineStep
name: EkLine Documentation Review
image:
name: ghcr.io/ekline-io/ekline-ci-cd:v6
script:
- export INPUT_EK_TOKEN=$EK_TOKEN
- export INPUT_CONTENT_DIR='<path_to_content_directory>'
# Uncomment and configure the following lines to use additional options:
# - export INPUT_EXCLUDE_DIRECTORIES='<dir_to_exclude>'
# - export INPUT_EXCLUDE_FILES='<file_to_exclude.md>'
- /code/entrypoint.sh
pipelines:
branches:
main:
- step: *runEkLineStep
pull-requests:
'**':
- step: *runEkLineStep

Replace <path_to_content_directory> with the path to your docs folder.

  1. In Bitbucket, go to Repository settings > Pipelines > Repository variables.
  2. Add a variable named EK_TOKEN. Set its value to your EkLine integration token.

To skip specific rules, set INPUT_IGNORE_RULE to a comma-separated list of rule IDs. For example, to skip EK00001 and EK00004, add this line to the step’s script. Put it before /code/entrypoint.sh:

- export INPUT_IGNORE_RULE="EK00001,EK00004"

Built on Potluck Docs, our open source template.