Skip to content

Commit 2c94c94

Browse files
committed
Add bin mount option to act defaults
1 parent 1275afc commit 2c94c94

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,49 +50,49 @@ To simplify the process of building this project from scratch, we provide build
5050
Execute this command in the project root folder to compile, assemble, and package all project components:
5151

5252
```bash
53-
act -s BUILD_ARGS="--make" -j build
53+
act -b -s BUILD_ARGS="--make" -j build
5454
```
5555

5656
You can also run the build only for a specific (sub-)component by providing the path to the component folder, as shown below:
5757

5858
```bash
59-
act -s BUILD_ARGS="--make" -s WORKING_DIRECTORY="./docs" -j build
59+
act -b -s BUILD_ARGS="--make" -s WORKING_DIRECTORY="./docs" -j build
6060
```
6161

6262
#### Run linting & style checks
6363

6464
To run all relevant linting and code style checks for all components, execute:
6565

6666
```bash
67-
act -s BUILD_ARGS="--check" -j build
67+
act -b -s BUILD_ARGS="--check" -j build
6868
```
6969

7070
#### Run integration & unit tests
7171

7272
Once all the project artifacts are build, you can execute this command in the project root folder to run the integration & unit tests for all components:
7373

7474
```bash
75-
act -s BUILD_ARGS="--test" -j build
75+
act -b -s BUILD_ARGS="--test" -j build
7676
```
7777

7878
It is also possible to combine multiple steps into one command:
7979

8080
```bash
81-
act -s BUILD_ARGS="--check --make --test" -j build
81+
act -b -s BUILD_ARGS="--check --make --test" -j build
8282
```
8383

8484
The `--check --make --test` steps are configured as default. If you call the job without `BUILD_ARGS` the build and test steps will be executed:
8585

8686
```bash
87-
act -j build
87+
act -b -j build
8888
```
8989

9090
#### Release a new version
9191

92-
To release a new version and publish all relevant artifacts to respective registries (e.g. Docker image to DockerHub), you need to first create a git version tag based on [Semantic Versioning](https://semver.org/) standard and, subsequently, run the release job:
92+
To release a new version and publish all relevant artifacts to respective registries (e.g. Docker image to DockerHub), run the release job with a valid version based on [Semantic Versioning](https://semver.org/) standard:
9393

9494
```bash
95-
git tag vMAJOR.MINOR.PATCH && act -j release
95+
act -b -s VERSION="<MAJOR.MINOR.PATCH>" -j release
9696
```
9797

9898
### Commit messages guidelines

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ The full Python API documentation can be found [here](https://github.com/ml-tool
222222
To simplify the process of building this project from scratch, we provide build-scripts that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:
223223

224224
```bash
225-
act -j build
225+
act -b -j build
226226
```
227227

228228
Refer to our [contribution guides](https://github.com/ml-tooling/lazydocs/blob/main/CONTRIBUTING.md#development-instructions) for more detailed information on our build scripts and development process.

0 commit comments

Comments
 (0)