Skip to content

Commit c556d85

Browse files
hermanschaafhermanschaaf
authored
chore(ci): Fix workflow that checks docs are up-to-date for v1 (#2107)
1 parent e407991 commit c556d85

174 files changed

Lines changed: 2537 additions & 2832 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/lint_doc.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ jobs:
2626
const { include: modules } = JSON.parse(MODULES)
2727
const withDocs = (await Promise.all(modules.map(async (module) => {
2828
try {
29-
await fs.access(`./${module.workdir}/docs/docs.go`, fs.F_OK)
29+
await fs.access(`./${module.workdir}/docs/tables`, fs.F_OK)
3030
return module
3131
} catch (e) {
3232
return
3333
}
3434
}))).filter(Boolean)
3535
return { include: withDocs }
3636
lint_doc:
37-
name: Lint Provider Doc
37+
name: Lint Plugin Docs
3838
needs: resolve-modules
3939
runs-on: ubuntu-latest
4040
strategy:
@@ -74,7 +74,7 @@ jobs:
7474
- name: build-docs
7575
if: steps.changed-files.outputs.any_changed == 'true'
7676
run: |
77-
go run ./docs/docs.go
77+
go run main.go doc docs/tables
7878
working-directory: ${{ matrix.workdir }}
7979
- name: Fail if docs are changed
8080
if: steps.changed-files.outputs.any_changed == 'true'

‎Makefile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,8 @@ install-tools:
3030
.PHONY: install-hooks
3131
install-hooks:
3232
pre-commit install
33+
34+
# Regenerate docs for all plugins
35+
.PHONY: update-docs
36+
update-docs:
37+
./scripts/update-docs.sh

‎plugins/source/aws/docs/tables/aws_autoscaling_group_scaling_policies.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Table: aws_autoscaling_group_scaling_policies
22

33

4-
The primary key for this table is **_cq_id**.
4+
The primary key for this table is **arn**.
55

66
## Relations
77
This table depends on [`aws_autoscaling_groups`](aws_autoscaling_groups.md).
@@ -12,6 +12,7 @@ This table depends on [`aws_autoscaling_groups`](aws_autoscaling_groups.md).
1212
|account_id|String|
1313
|region|String|
1414
|group_arn|String|
15+
|arn (PK)|String|
1516
|adjustment_type|String|
1617
|alarms|JSON|
1718
|auto_scaling_group_name|String|
@@ -21,12 +22,11 @@ This table depends on [`aws_autoscaling_groups`](aws_autoscaling_groups.md).
2122
|metric_aggregation_type|String|
2223
|min_adjustment_magnitude|Int|
2324
|min_adjustment_step|Int|
24-
|policy_arn|String|
2525
|policy_name|String|
2626
|policy_type|String|
2727
|predictive_scaling_configuration|JSON|
2828
|scaling_adjustment|Int|
2929
|step_adjustments|JSON|
3030
|target_tracking_configuration|JSON|
31-
|_cq_id (PK)|UUID|
31+
|_cq_id|UUID|
3232
|_cq_fetch_time|Timestamp|

‎plugins/source/aws/docs/tables/aws_backup_vault_recovery_points.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Table: aws_backup_vault_recovery_points
22

33

4-
The primary key for this table is **_cq_id**.
4+
The primary key for this table is **arn**.
55

66
## Relations
77
This table depends on [`aws_backup_vaults`](aws_backup_vaults.md).
@@ -12,6 +12,7 @@ This table depends on [`aws_backup_vaults`](aws_backup_vaults.md).
1212
|account_id|String|
1313
|region|String|
1414
|vault_arn|String|
15+
|arn (PK)|String|
1516
|tags|JSON|
1617
|backup_size_in_bytes|Int|
1718
|backup_vault_arn|String|
@@ -25,11 +26,10 @@ This table depends on [`aws_backup_vaults`](aws_backup_vaults.md).
2526
|is_encrypted|Bool|
2627
|last_restore_time|Timestamp|
2728
|lifecycle|JSON|
28-
|recovery_point_arn|String|
2929
|resource_arn|String|
3030
|resource_type|String|
3131
|source_backup_vault_arn|String|
3232
|status|String|
3333
|status_message|String|
34-
|_cq_id (PK)|UUID|
34+
|_cq_id|UUID|
3535
|_cq_fetch_time|Timestamp|

‎plugins/source/aws/docs/tables/aws_ec2_ebs_snapshots.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The primary key for this table is **arn**.
1010
|account_id|String|
1111
|region|String|
1212
|arn (PK)|String|
13-
|attribute|String|
13+
|attribute|JSON|
1414
|data_encryption_key_id|String|
1515
|description|String|
1616
|encrypted|Bool|

‎plugins/source/aws/docs/tables/aws_ec2_instances.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The primary key for this table is **arn**.
1010
|account_id|String|
1111
|region|String|
1212
|arn (PK)|String|
13+
|state_transition_reason_time|Timestamp|
1314
|ami_launch_index|Int|
1415
|architecture|String|
1516
|block_device_mappings|JSON|

‎plugins/source/aws/docs/tables/aws_ecs_task_definitions.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Table: aws_ecs_task_definitions
22

33

4-
The primary key for this table is **_cq_id**.
4+
The primary key for this table is **arn**.
55

66

77
## Columns
88
| Name | Type |
99
| ------------- | ------------- |
1010
|account_id|String|
1111
|region|String|
12+
|arn (PK)|String|
1213
|tags|JSON|
1314
|compatibilities|StringArray|
1415
|container_definitions|JSON|
@@ -31,8 +32,7 @@ The primary key for this table is **_cq_id**.
3132
|revision|Int|
3233
|runtime_platform|JSON|
3334
|status|String|
34-
|task_definition_arn|String|
3535
|task_role_arn|String|
3636
|volumes|JSON|
37-
|_cq_id (PK)|UUID|
37+
|_cq_id|UUID|
3838
|_cq_fetch_time|Timestamp|

‎plugins/source/aws/docs/tables/aws_elasticbeanstalk_environments.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The following tables depend on `aws_elasticbeanstalk_environments`:
1212
| Name | Type |
1313
| ------------- | ------------- |
1414
|account_id (PK)|String|
15+
|arn|String|
1516
|region|String|
1617
|tags|JSON|
1718
|id (PK)|String|
@@ -23,7 +24,6 @@ The following tables depend on `aws_elasticbeanstalk_environments`:
2324
|date_updated|Timestamp|
2425
|description|String|
2526
|endpoint_url|String|
26-
|environment_arn|String|
2727
|environment_links|JSON|
2828
|environment_name|String|
2929
|health|String|

‎plugins/source/aws/docs/tables/aws_lambda_function_aliases.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Table: aws_lambda_function_aliases
22

33

4-
The primary key for this table is **_cq_id**.
4+
The primary key for this table is **arn**.
55

66
## Relations
77
This table depends on [`aws_lambda_functions`](aws_lambda_functions.md).
@@ -12,12 +12,12 @@ This table depends on [`aws_lambda_functions`](aws_lambda_functions.md).
1212
|account_id|String|
1313
|region|String|
1414
|function_arn|String|
15-
|alias_arn|String|
15+
|arn (PK)|String|
1616
|description|String|
1717
|function_version|String|
1818
|name|String|
1919
|revision_id|String|
2020
|routing_config|JSON|
2121
|url_config|JSON|
22-
|_cq_id (PK)|UUID|
22+
|_cq_id|UUID|
2323
|_cq_fetch_time|Timestamp|

‎plugins/source/aws/docs/tables/aws_redshift_cluster_parameter_groups.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Table: aws_redshift_cluster_parameter_groups
2+
3+
4+
The composite primary key for this table is (**cluster_arn**, **parameter_group_name**).
5+
6+
## Relations
7+
This table depends on [`aws_redshift_clusters`](aws_redshift_clusters.md).
8+
The following tables depend on `aws_redshift_cluster_parameter_groups`:
9+
- [`aws_redshift_cluster_parameters`](aws_redshift_cluster_parameters.md)
10+
11+
## Columns
12+
| Name | Type |
13+
| ------------- | ------------- |
14+
|account_id|String|
15+
|region|String|
16+
|cluster_arn (PK)|String|
17+
|parameter_group_name (PK)|String|
18+
|cluster_parameter_status_list|JSON|
19+
|parameter_apply_status|String|
20+
|_cq_id|UUID|
21+
|_cq_fetch_time|Timestamp|

0 commit comments

Comments
 (0)