Skip to content

Commit

Permalink
update doc with a full pipeline example
Browse files Browse the repository at this point in the history
  • Loading branch information
llaville committed Sep 4, 2024
1 parent 75b81b0 commit 486791b
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
Binary file added docs/assets/images/wf-part1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/wf-part2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/wf-part3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 56 additions & 0 deletions docs/run-all-stages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!-- markdownlint-disable MD013 MD046 -->
# Run all stages with one command

If you're well understand each previous `make` commands of the pipeline, you want probably executed all stages at once.

You've just to combine all commands (arguments and options), to make it real.

For example: We will build all manifests for BOX Manifest distribution itself.

=== "Pipeline Command"

```shell
box-manifest build stub configure compile -r console-table.txt -r plain.txt -r sbom.json --output-stub stub.php --output-conf box.json.dist -vvv
```

=== "Output"

![Workflow part 1](./assets/images/wf-part1.png)
![Workflow part 2](./assets/images/wf-part2.png)
![Workflow part 3](./assets/images/wf-part3.png)

## :material-numeric-1-box: Build manifests

Here are the part required of full above command

```shell
box-manifest make build -r console-table.txt -r plain.txt -r sbom.json
```

## :material-numeric-2-box: Build stub

Here are the part required of full above command

```shell
box-manifest make stub --output-stub stub.php
```

## :material-numeric-3-box: Configure the BOX final config file

Here are the part required of full above command

```shell
box-manifest make configure --output-stub stub.php --output-conf box.json.dist
```

## :material-numeric-4-box: Compile the PHAR distribution

Here are the part required of full above command

```shell
box-manifest make compile --output-conf box.json.dist
```

> [!TIP]
>
> Don't forget to increase verbosity (`-vvv`) to see all console logs.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ nav:
- "Build your stub": build-your-stub.md
- "Build your Box config file": build-your-config.md
- "Compile your PHAR": compile-your-phar.md
- "Make them all": run-all-stages.md
- "Customization":
- "Built-in stages":
- stages/README.md
Expand Down

0 comments on commit 486791b

Please sign in to comment.