From bef8fc8e7f46a26279f0aecfc4411148b12903b8 Mon Sep 17 00:00:00 2001 From: Michael Sprengel Date: Mon, 4 Dec 2023 09:52:25 +0100 Subject: [PATCH] Add documentation for missing workflow parameters (#40) --- README.md | 1 + docs/workflow.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fa6aa08..1d043d0 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ It contains: - `bin/`: This folder contains executable scripts installs into the container. > Note: Also available via bind mount in the workflow for enable the possibility of workflow development tests. - `conf/`: This folder contains containers configurations on installed packages list and native container setup. +- `docs/`: This directory contains the documentation related to the package pipeline of Garden Linux. - `misc/`: This folder contains miscellaneous files related to the project. - `scripts/`: This folder contains scripts for it's github actions workflow. diff --git a/docs/workflow.md b/docs/workflow.md index 7427f21..6adc221 100644 --- a/docs/workflow.md +++ b/docs/workflow.md @@ -28,7 +28,7 @@ The `build_container.yml` workflow is responsible for building container images #### Workflow Configuration -The `container/` folder in this project contains all it's configurations. The `build_container.yml` workflow is triggered on every push to the repository. +The `container/` folder in this project contains all its configurations. The `build_container.yml` workflow is triggered on every push to the repository. #### Job Details @@ -61,6 +61,8 @@ Input Parameters available in `build_pkg.yml`: |`message`|**Type:** string
**Default:** `Rebuild for Garden Linux.`| The changelog entry message for the package build.| |`build_option`|**Type:** string| Additional build options for the package build. Build option `terse` is always set.| |`build_profiles`|**Type:** string| Additional build profiles for the package build.| +|`git_filter`|**Type:** string
**Default:** `.*`
**Scope:** `source: git`| This parameter let's you filter Git tags that should be skipped for the upstream version determination. | +|`git_tag_match`|**Type:** string
**Default:** `(.*)`
**Scope:** `source: git`| This parameter defines what part of a given Git Tag is considered to be the upstream version. The first regex match group is always the designated upstream version. | #### Job Details @@ -97,8 +99,6 @@ Replace `project` to other package name of your package-project. Replace `branch 4. Commit and push the new workflow file to your project's repository. 5. The `build_pkg.yml` workflow will be triggered based on the provided inputs. -> Note: Make sure to adjust and use the matches branch name on your package-project in the uses field to match the desired branch name of the `build_pkg.yaml@branchname`` workflow. - ## Contributing Contributions to this repository are welcome. If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.