Skip to content

Commit 44b057e

Browse files
lukasmasuchactions-user
authored andcommitted
Apply automatic release changes for v0.6.6
1 parent b73c734 commit 44b057e

File tree

11 files changed

+120
-87
lines changed

11 files changed

+120
-87
lines changed

Pipfile.lock

Lines changed: 24 additions & 24 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ if args.get(build_utils.FLAG_RELEASE):
471471
Install the tools in the Dockerfile in your `.github/actions/build-environment/Dockerfile` as demonstrated in this example:
472472

473473
```Dockerfile
474-
FROM mltooling/build-environment:0.6.1
474+
FROM mltooling/build-environment:0.6.6
475475

476476
# Install Go Runtime
477477
RUN apt-get update \
@@ -483,7 +483,7 @@ RUN apt-get update \
483483
You can extend or overwrite the default entrypoint with your custom entrypoint script (e.g. `extended-entrypoint.sh`) as shown below:
484484

485485
```Dockerfile
486-
FROM mltooling/build-environment:0.6.1
486+
FROM mltooling/build-environment:0.6.6
487487

488488
COPY extended-entrypoint.sh /extended-entrypoint.sh
489489

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
FROM mltooling/build-environment:0.6.1
1+
FROM mltooling/build-environment:0.6.6

docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
## Functions
1818

1919
- [`build_utils.build`](./universal_build.build_utils.md#function-build): Run the build logic of the specified component, except if the path is a (sub-)path in skipped-paths.
20+
- [`build_utils.command_exists`](./universal_build.build_utils.md#function-command_exists): Checks whether the `command` exists and is marked as executable.
2021
- [`build_utils.create_git_tag`](./universal_build.build_utils.md#function-create_git_tag): Create an annotated git tag in the current HEAD via `git tag` and the provided version.
2122
- [`build_utils.duplicate_folder`](./universal_build.build_utils.md#function-duplicate_folder): Duplicate a folder into another folder.
2223
- [`build_utils.exit_process`](./universal_build.build_utils.md#function-exit_process): Exit the process with exit code.
@@ -40,7 +41,7 @@
4041
- [`build_python.code_checks`](./universal_build.helpers.build_python.md#function-code_checks): Run linting and style checks.
4142
- [`build_python.generate_api_docs`](./universal_build.helpers.build_python.md#function-generate_api_docs): Generates API documentation via lazydocs.
4243
- [`build_python.install_build_env`](./universal_build.helpers.build_python.md#function-install_build_env): Installs a new virtual environment via pipenv.
43-
- [`build_python.is_pipenv_environment`](./universal_build.helpers.build_python.md#function-is_pipenv_environment)
44+
- [`build_python.is_pipenv_environment`](./universal_build.helpers.build_python.md#function-is_pipenv_environment): Check if current working directory is a valid pipenv environment.
4445
- [`build_python.parse_arguments`](./universal_build.helpers.build_python.md#function-parse_arguments): Parses all arguments and returns a sanitized & augmented list of arguments.
4546
- [`build_python.publish_pypi_distribution`](./universal_build.helpers.build_python.md#function-publish_pypi_distribution): Publish distribution to pypi.
4647
- [`build_python.test_with_py_version`](./universal_build.helpers.build_python.md#function-test_with_py_version): Run pytest in a environment wiht the specified python version.

docs/universal_build.build_utils.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,37 @@ Log message to stdout.
4747

4848
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L89"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
4949

50+
## <kbd>function</kbd> `command_exists`
51+
52+
```python
53+
command_exists(
54+
command: str,
55+
silent: bool = False,
56+
exit_on_error: bool = False
57+
) → bool
58+
```
59+
60+
Checks whether the `command` exists and is marked as executable.
61+
62+
63+
64+
**Args:**
65+
66+
- <b>`command`</b> (str): Command to check.
67+
- <b>`silent`</b> (bool): If `True`, no message will be logged in case the command does not exist. Default is `False`.
68+
- <b>`exit_on_error`</b> (bool, optional): Exit process if the command does not exist. Defaults to `False`.
69+
70+
71+
72+
**Returns:**
73+
74+
- <b>`bool`</b>: `True` if the commend exist and is executable.
75+
76+
77+
---
78+
79+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L121"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
80+
5081
## <kbd>function</kbd> `parse_arguments`
5182

5283
```python
@@ -76,7 +107,7 @@ Sanitized means that, for example, the version is already checked and set depend
76107

77108
---
78109

79-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L221"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
110+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L253"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
80111

81112
## <kbd>function</kbd> `create_git_tag`
82113

@@ -100,6 +131,7 @@ The version will be prefixed with 'v'. If push is set, the tag is pushed to remo
100131
- <b>`version`</b> (str): The tag to be created. Will be prefixed with 'v'.
101132
- <b>`push`</b> (bool, optional): If true, push the tag to remote. Defaults to False.
102133
- <b>`force`</b> (bool, optional): If true, force the tag to be created. Defaults to False.
134+
- <b>`exit_on_error`</b> (bool): Exit program if the tag creation fails.
103135

104136

105137

@@ -110,7 +142,7 @@ The version will be prefixed with 'v'. If push is set, the tag is pushed to remo
110142

111143
---
112144

113-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L257"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
145+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L290"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
114146

115147
## <kbd>function</kbd> `build`
116148

@@ -130,7 +162,7 @@ Run the build logic of the specified component, except if the path is a (sub-)pa
130162

131163
---
132164

133-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L279"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
165+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L312"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
134166

135167
## <kbd>function</kbd> `run`
136168

@@ -164,7 +196,7 @@ Run a specified command.
164196

165197
---
166198

167-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L338"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
199+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L371"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
168200

169201
## <kbd>function</kbd> `exit_process`
170202

@@ -179,7 +211,7 @@ Exit the process with exit code.
179211

180212
---
181213

182-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L353"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
214+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L386"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
183215

184216
## <kbd>function</kbd> `replace_in_files`
185217

@@ -208,7 +240,7 @@ Replaces a string or regex occurence in a collection of files.
208240

209241
---
210242

211-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L394"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
243+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L427"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
212244

213245
## <kbd>function</kbd> `get_latest_version`
214246

@@ -221,7 +253,7 @@ Returns the latest version based on Git tags.
221253

222254
---
223255

224-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L404"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
256+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/build_utils.py#L437"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
225257

226258
## <kbd>function</kbd> `duplicate_folder`
227259

docs/universal_build.helpers.build_docker.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Run vulnerability checks on Dockerimage.
5757
**Args:**
5858

5959
- <b>`image`</b> (str): The name of the docker image to check.
60-
- <b>`trivy`</b> (bool, optional): Activate trivy vulnerability check. Defaults to True.
60+
- <b>`trivy`</b> (bool, optional): Activate trivy vulnerability check. Defaults to `True`.
6161
- <b>`exit_on_error`</b> (bool, optional): If `True`, exit process as soon as an error occurs.
6262

6363

@@ -68,7 +68,7 @@ Run vulnerability checks on Dockerimage.
6868
## <kbd>function</kbd> `lint_dockerfile`
6969

7070
```python
71-
lint_dockerfile(exit_on_error: bool = True) → None
71+
lint_dockerfile(hadolint: bool = True, exit_on_error: bool = True) → None
7272
```
7373

7474
Run hadolint on the Dockerfile.
@@ -77,12 +77,13 @@ Run hadolint on the Dockerfile.
7777

7878
**Args:**
7979

80+
- <b>`hadolint`</b> (bool, optional): Activate hadolint dockerfile linter. Defaults to `True`.
8081
- <b>`exit_on_error`</b> (bool, optional): Exit process if an error occurs. Defaults to `True`.
8182

8283

8384
---
8485

85-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_docker.py#L79"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
86+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_docker.py#L81"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
8687

8788
## <kbd>function</kbd> `get_image_name`
8889

@@ -109,7 +110,7 @@ Get a valid versioned image name.
109110

110111
---
111112

112-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_docker.py#L96"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
113+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_docker.py#L98"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
113114

114115
## <kbd>function</kbd> `build_docker_image`
115116

@@ -144,7 +145,7 @@ Build a docker image from a Dockerfile in the working directory.
144145

145146
---
146147

147-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_docker.py#L144"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
148+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_docker.py#L149"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
148149

149150
## <kbd>function</kbd> `release_docker_image`
150151

docs/universal_build.helpers.build_mkdocs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Installs a new virtual environment via pipenv.
2727

2828
---
2929

30-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
30+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
3131

3232
## <kbd>function</kbd> `lint_markdown`
3333

3434
```python
35-
lint_markdown(exit_on_error: bool = True) → None
35+
lint_markdown(markdownlint: bool = True, exit_on_error: bool = True) → None
3636
```
3737

3838
Run markdownlint on markdown documentation.
@@ -41,12 +41,13 @@ Run markdownlint on markdown documentation.
4141

4242
**Args:**
4343

44+
- <b>`markdownlint`</b> (bool, optional): Activate markdown linting via `markdownlint`. Defaults to `True`.
4445
- <b>`exit_on_error`</b> (bool, optional): Exit process if an error occurs. Defaults to `True`.
4546

4647

4748
---
4849

49-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L48"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
50+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L55"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
5051

5152
## <kbd>function</kbd> `build_mkdocs`
5253

@@ -65,7 +66,7 @@ Build mkdocs markdown documentation.
6566

6667
---
6768

68-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L62"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
69+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L72"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
6970

7071
## <kbd>function</kbd> `deploy_gh_pages`
7172

@@ -84,7 +85,7 @@ Deploy mkdocs documentation to Github pages.
8485

8586
---
8687

87-
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L81"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
88+
<a href="https://github.com/ml-tooling/universal-build/blob/main/src/universal_build/helpers/build_mkdocs.py#L94"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
8889

8990
## <kbd>function</kbd> `run_dev_mode`
9091

0 commit comments

Comments
 (0)