Skip to content

Add documentation and NEWS entry about bst-docker-import

Chandan Singhrequested to merge
chandan/bst-and-docker into master

Description

contrib/bst-docker-import was recently added in !857 (merged) but that MR only included the script itself. In this MR, we add some documentation about how to install it and use it, and also mention it in the NEWS file.

Changes proposed in this merge request:

  • doc: Add new document about Docker integrations

    Add a new section under "Additional writings" section about how BuildStream integrates with Docker. At present, this section includes only two sections:

    • "Run BuildStream inside Docker", that refers to existing instructions for doing so
    • "Generate Docker images", that adds instructions for using the newly added contrib/bst-docker-import script

    In future, this document can be extended to include the following things:

    • Importing Docker sources via docker source plugin - if/when the Docker source plguin is moved from bst-external to BuildStream proper
    • A Docker sandbox, if/when that is added

  • NEWS: Add entry about contrib/bst-docker-import

    As suggested in !857 (comment 106809743), add a NEWS entry for contrib/bst-docker-import that was added recently.

This merge request, when approved, will close:

No issue as such, but suggested by @aevri in !857 (comment 106809743).

Merge request reports