Skip to content

Commit 28c7b3c

Browse files
furkhatFurkhat Kasymov Genii Uulu
andauthored
chore: fix github workflow for docs check (#131)
Co-authored-by: Furkhat Kasymov Genii Uulu <furkhat@cast.ai>
1 parent ae179fa commit 28c7b3c

File tree

3 files changed

+17
-19
lines changed

3 files changed

+17
-19
lines changed

.github/workflows/documentation.yaml

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,21 @@ jobs:
1313
- name: Checkout repository
1414
uses: actions/checkout@v4
1515

16-
- name: Setup terraform-docs
17-
uses: terraform-docs/gh-actions@v1.2.0
16+
- name: Generate documentation
17+
uses: terraform-docs/gh-actions@v1.4.1
1818
with:
1919
working-dir: .
2020
output-file: README.md
21-
output-method: inject
22-
git-push: "false"
21+
fail-on-diff: false
2322

24-
- name: Check if README.md is up-to-date
23+
- name: Check for uncommitted changes
2524
run: |
26-
make generate-doc
25+
git status
2726
if [ -n "$(git status --porcelain)" ]; then
28-
echo "ERROR: README.md is not up-to-date. Run 'make generate-doc' locally and commit the changes."
29-
echo
30-
git diff
31-
echo
32-
git status
27+
echo "::error::README.md is not up-to-date. Run 'make generate-doc' locally and commit the changes."
28+
echo ""
29+
echo "Changes needed:"
30+
git diff HEAD
3331
exit 1
3432
fi
3533
echo "README.md is up-to-date!"

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -434,19 +434,19 @@ Usage examples are located in [terraform provider repo](https://github.com/casta
434434
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
435435
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | ~> 3 |
436436
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >= 3.7.0 |
437-
| <a name="requirement_castai"></a> [castai](#requirement\_castai) | >= 8.3 |
437+
| <a name="requirement_castai"></a> [castai](#requirement\_castai) | >= 8.7 |
438438
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 3.0.0 |
439439
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3 |
440440

441441
## Providers
442442

443443
| Name | Version |
444444
|------|---------|
445-
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 3.7.0 |
446-
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 4.57.0 |
447-
| <a name="provider_castai"></a> [castai](#provider\_castai) | 8.8.0 |
448-
| <a name="provider_helm"></a> [helm](#provider\_helm) | 3.1.1 |
449-
| <a name="provider_null"></a> [null](#provider\_null) | 3.2.4 |
445+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | ~> 3 |
446+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | >= 3.7.0 |
447+
| <a name="provider_castai"></a> [castai](#provider\_castai) | >= 8.7 |
448+
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 3.0.0 |
449+
| <a name="provider_null"></a> [null](#provider\_null) | ~> 3 |
450450

451451
## Modules
452452

@@ -531,7 +531,7 @@ Usage examples are located in [terraform provider repo](https://github.com/casta
531531
| <a name="input_install_pod_mutator"></a> [install\_pod\_mutator](#input\_install\_pod\_mutator) | Optional flag for installation of pod mutator | `bool` | `false` | no |
532532
| <a name="input_install_security_agent"></a> [install\_security\_agent](#input\_install\_security\_agent) | Optional flag for installation of security agent (Kvisor - https://docs.cast.ai/docs/kvisor) | `bool` | `false` | no |
533533
| <a name="input_install_workload_autoscaler"></a> [install\_workload\_autoscaler](#input\_install\_workload\_autoscaler) | Optional flag for installation of workload autoscaler (https://docs.cast.ai/docs/workload-autoscaling-configuration) | `bool` | `false` | no |
534-
| <a name="input_kvisor_controller_extra_args"></a> [kvisor\_controller\_extra\_args](#input\_kvisor\_controller\_extra\_args) | ⚠️ DEPRECATED: use kvisor\_values instead (see example: https://github.com/castai/terraform-provider-castai/tree/master/examples/aks/aks_cluster_with_security/castai.tf ). Extra arguments for the kvisor controller. Optionally enable kvisor to lint Kubernetes YAML manifests, scan workload images and check if workloads pass CIS Kubernetes Benchmarks as well as NSA, WASP and PCI recommendations. | `map(string)` | <pre>{<br> "image-scan-enabled": "true",<br> "kube-bench-enabled": "true",<br> "kube-linter-enabled": "true"<br>}</pre> | no |
534+
| <a name="input_kvisor_controller_extra_args"></a> [kvisor\_controller\_extra\_args](#input\_kvisor\_controller\_extra\_args) | ⚠️ DEPRECATED: use kvisor\_values instead (see example: https://github.com/castai/terraform-provider-castai/tree/master/examples/aks/aks_cluster_with_security/castai.tf ). Extra arguments for the kvisor controller. Optionally enable kvisor to lint Kubernetes YAML manifests, scan workload images and check if workloads pass CIS Kubernetes Benchmarks as well as NSA, WASP and PCI recommendations. | `map(string)` | <pre>{<br/> "image-scan-enabled": "true",<br/> "kube-bench-enabled": "true",<br/> "kube-linter-enabled": "true"<br/>}</pre> | no |
535535
| <a name="input_kvisor_grpc_addr"></a> [kvisor\_grpc\_addr](#input\_kvisor\_grpc\_addr) | CAST AI Kvisor optimized GRPC API address | `string` | `"kvisor.prod-master.cast.ai:443"` | no |
536536
| <a name="input_kvisor_values"></a> [kvisor\_values](#input\_kvisor\_values) | List of YAML formatted string values for kvisor helm chart, see example: https://github.com/castai/terraform-provider-castai/tree/master/examples/aks/aks_cluster_with_security/castai.tf | `list(string)` | `[]` | no |
537537
| <a name="input_kvisor_version"></a> [kvisor\_version](#input\_kvisor\_version) | Version of kvisor chart. If not provided, latest version will be used. | `string` | `null` | no |

versions.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ terraform {
1212
}
1313
castai = {
1414
source = "castai/castai"
15-
version = ">= 8.3"
15+
version = ">= 8.7"
1616
}
1717
helm = {
1818
source = "hashicorp/helm"

0 commit comments

Comments
 (0)