EkLine Bitbucket integration guide
Prerequisites
Section titled “Prerequisites”- An EkLine integration token. Get it from Settings > Organization > Access in the EkLine dashboard.
- A Bitbucket account with permission to set up pipelines.
Create bitbucket-pipelines.yml file
Section titled “Create bitbucket-pipelines.yml file”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: *runEkLineStepReplace <path_to_content_directory> with the path to your docs folder.
Configure Bitbucket environment variables
Section titled “Configure Bitbucket environment variables”- In Bitbucket, go to Repository settings > Pipelines > Repository variables.
- Add a variable named
EK_TOKEN. Set its value to your EkLine integration token.
Configure input options
Section titled “Configure input options”Ignoring specific rules (optional)
Section titled “Ignoring specific rules (optional)”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"Next steps
Section titled “Next steps”- Ignoring rules: handle false positives and turn off specific checks
- Framework support: set up EkLine for MDX, Astro, Docusaurus, and other frameworks
- GitHub Actions integration: set up EkLine in GitHub if you also use GitHub
- Docs Agent: write and update docs from your code with AI
Built on Potluck Docs, our open source template.