Skip to content

Commit c07482d

Browse files
Datacom-Aydengithub-actions[bot]
authored andcommitted
Automated documentation update [skip ci]
1 parent 64fee3f commit c07482d

3 files changed

Lines changed: 24 additions & 37 deletions

File tree

src/aikido-precommit/README.md

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Aikido Secrets Pre-commit Hook (aikido-precommit)
23

34
Installs AikidoSec's pre-commit hook for scanning secrets, passwords, and API keys before commits
@@ -12,33 +13,13 @@ Installs AikidoSec's pre-commit hook for scanning secrets, passwords, and API ke
1213

1314
## Options
1415

15-
Options Id | Description | Type | Default Value
16-
---------------- | -------------------------------------------------------------------------------- | ------- | -------------
17-
version | Version of the aikido-local-scanner to install (use 'latest' for auto-detection) | string | latest
18-
setupGlobalHooks | Configure git global hooks path (set to false for download-only) | boolean | true
19-
20-
## Version Management
21-
22-
This feature supports two version strategies:
23-
24-
### Auto-detection (default)
25-
26-
With `version: "latest"` (the default), the installer fetches the current version from [Aikido's official install script](https://github.com/AikidoSec/pre-commit/blob/main/installation-samples/install-global/install-aikido-hook.sh) at build time. This ensures you always get the latest scanner version without manual updates.
27-
28-
If the upstream script is unreachable, a fallback version is used (kept up-to-date via automated PRs).
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | Version of the aikido-local-scanner to install (use 'latest' for auto-detection) | string | latest |
19+
| setupGlobalHooks | Configure git global hooks path (set to false for download-only) | boolean | true |
2920

30-
### Pinned version
3121

32-
For reproducible builds or to use a specific version, set an explicit version:
33-
34-
```json
35-
"features": {
36-
"ghcr.io/ProxayFox/devcontainer-features/aikido-precommit:1": {
37-
"version": "v1.0.116"
38-
}
39-
}
40-
```
4122

42-
--------------------------------------------------------------------------------
23+
---
4324

44-
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/ProxayFox/devcontainer-features/blob/main/src/aikido-precommit/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
25+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/ProxayFox/devcontainer-features/blob/main/src/aikido-precommit/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/clickhouse-local/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# ClickHouse Local CLI (clickhouse-local)
23

34
Installs ClickHouse local CLI for SQL queries on local files
@@ -12,11 +13,13 @@ Installs ClickHouse local CLI for SQL queries on local files
1213

1314
## Options
1415

15-
Options Id | Description | Type | Default Value
16-
------------- | ---------------------------------------------------------------- | ------ | -------------
17-
version | ClickHouse version to install | string | latest
18-
installMethod | Installation method: 'quick' (binary) or 'apt' (package manager) | string | quick
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | ClickHouse version to install | string | latest |
19+
| installMethod | Installation method: 'quick' (binary) or 'apt' (package manager) | string | quick |
20+
21+
1922

20-
--------------------------------------------------------------------------------
23+
---
2124

22-
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/ProxayFox/devcontainer-features/blob/main/src/clickhouse-local/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
25+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/ProxayFox/devcontainer-features/blob/main/src/clickhouse-local/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/lazydocker/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# lazydocker (lazydocker)
23

34
A simple terminal UI for both docker and docker-compose
@@ -12,10 +13,12 @@ A simple terminal UI for both docker and docker-compose
1213

1314
## Options
1415

15-
Options Id | Description | Type | Default Value
16-
---------- | -------------------------------- | ------ | -------------
17-
version | Version of lazydocker to install | string | 0.24.2
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | Version of lazydocker to install | string | 0.24.2 |
19+
20+
1821

19-
--------------------------------------------------------------------------------
22+
---
2023

21-
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/ProxayFox/devcontainer-features/blob/main/src/lazydocker/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
24+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/ProxayFox/devcontainer-features/blob/main/src/lazydocker/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

0 commit comments

Comments
 (0)