Is it possible to validate a pipeline locally?

Question

Hi, I know about the bitbucket pipelines validator. I was wondering if there is a cli version to run locally, or some tips on how to validate as much as possible before pushing. It would greatly speed up the pipeline creation flow for me.

Couldn't find anything on atlassian repos or in the forums.

Thanks!

ktomk · Answer

Hello @Jesus Gollonet , validation against a schema similar to the one already mentioned is also possible with this local pipelines runner (shameless plug, written by me) which allows to validate the file on the command-line:

$ pipelines --validate

The schema (currently) is even with the latest Bitbucket Pipeline features, which the Vscode plugin does not validate yet. But I can also imagine that it can be lacking in the future whoever updates first.

There is no need to commit the file (or any related files) and the utility is designed with the (local) project in mind. It is also possible to do a dry-run to run further tests:

$ pipelines --trigger branch:master --dry-run

Or even execute it (which might need some environment variable setup, dot-env files are supported, incl. distribution templates - docker style).

It's not that everything works the same, I extend it as I need it. But I use it a lot for things like you ask for and also complete offline use for development.

Since some time there is also an accompanying homepage on Github, the read-me is going to outgrow:

* Pipelines - Run Bitbucket Pipelines Wherever They Dock

Maybe it's useful to you.

Philip Hodder · Answer

Hello,

You can validate the bitbucket-pipelines.yml YAML format locally in our VS Code integration.

There is no local Pipelines agent that you can run your build locally with. You can open a feature request, for such a thing, here: https://bitbucket.org/site/master/issues/new

You can create a similar environment to Pipelines by running your scripts inside of Docker. And use that to debug your scripts locally. See here for more details: https://confluence.atlassian.com/bitbucket/debug-your-pipelines-locally-with-docker-838273569.html

Thanks,

Phil