Capabilities

Since we have :

• Composer (a Dependency Manager for PHP) with show command that displays detailed information about a package,
• Docker manifest command to manage Docker image manifests and manifest lists,
• SBOM (Software Bill of Materials) as industry standards as a key building block in software security and software supply chain risk management,

No solution existed before BOX Manifest to implement the same feature into PHAR (PHP Archive) distribution.

From first version until latest one available (4.6), the BOX project does not add yet ability to include inventory of your software (dependencies).

This is the goal of BOX Manifest companion : add this missing but so important feature.

• Generates individual file in specific format (plain text, Symfony Console Table, SBOM XML or JSON, and more ...)
• Identify them into the BOX configuration file
• Compiles the PHAR distribution of your application including all your manifests

This project has evolved since three major versions, and now happy to announce a next step improvement with major version 4.

Pipeline of make command

The following diagram describe the behavior of the new make command.

Note

The make command may combine one or more stages on same run !

stateDiagram
    direction LR
    classDef BuildEvent font-style:italic,font-weight:bold
    BuildStage : Generates the PHAR manifest file(s)
    BuildManifest : Create a manifest in specific format
    StubStage : Generates the PHAR bootstrapping file
    ConfigureStage : Generates the final BOX config file
    CompileStage : Compiles an application into a PHAR
    [*] --> BuildStage:::BuildEvent
    state if_other_resource <<choice>>
    state BuildStage {
        [*] --> BuildManifest
        BuildManifest --> if_other_resource
        if_other_resource --> BuildManifest : if multiple resource
        if_other_resource --> [*] : if single resource
    }
    [*] --> StubStage
    [*] --> ConfigureStage
    [*] --> CompileStage
    BuildStage --> [*]
    StubStage --> [*]
    ConfigureStage --> [*]
    CompileStage --> [*]
    note left of BuildStage : make build
    note left of StubStage : make stub
    note left of ConfigureStage : make configure
    note left of CompileStage : make compile

Important

If these default behaviours does not match your needs, you have also possibility to add your own stage(s) in the pipeline at any position.