mkdocs gh-deploy starts server in CI job

[fansari1-equinix]

Hi guys.
I am trying to use the squidfunk/mkdocs-material container to run the command mkdocs gh-deploy into my CI.

The idea is to automate the deployment whenever anything changes in the doc application repo so that the mkdocs gh-deploy command will automatically deploy the changes on the respective pages.

However, I'm facing issues in the CI where the mkdocs gh-deploy command.
The server starts locally within the CI environment and the job does not pass/fail.

How should I proceed if I just want to execute the mkdocs gh-deploy in the CI?
Thanks.

My Buildkite CI for ref.

steps:
  - label:  ":shrek: Deploy docs"
    key:  "mkdocs-deploy-docs"
    plugins:
      - docker#v5.9.0:
          image:  "squidfunk/mkdocs-material"
          commands: |
            "mkdocs gh-deploy"

[kamilkrzyskow]

Hello @fansari1-equinix,
as per the publishing guide:
https://squidfunk.github.io/mkdocs-material/publishing-your-site/

The docker image is not mentioned there, as the docker image runs a mkdocs serve command at the end.

One option is to follow the guide and set up your own CI for installing all of the things.

Another is to create your own Docker image without the command to run the server. There is a guide for Insiders users for creating one: https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#with-docker

And lastly looking at the docs there is a way to run the docker image with special options according to:
https://squidfunk.github.io/mkdocs-material/creating-your-site/#building-your-site

But I don't know how to run the "-it" flags in CI, so you'd have to search Buildkite docs yourself.