Skip to content

Commit

Permalink
Add documentation for missing workflow parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
nanory committed Dec 4, 2023
1 parent df5f85a commit 3bb4b4d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -61,6 +61,8 @@ Input Parameters available in `build_pkg.yml`:
|`message`|**Type:** string<br>**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<br>**Default:** `.*`<br>**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<br>**Default:** `(.*)`<br>**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
Expand Down Expand Up @@ -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.

0 comments on commit 3bb4b4d

Please sign in to comment.