-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add cdktf documentation update steps into release process
Co-authored-by: Brian Flad <[email protected]>
- Loading branch information
1 parent
6473058
commit e9747b5
Showing
10 changed files
with
581 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| name: CDKTF docs | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| cdktfDocs: | ||
| runs-on: ubuntu-latest | ||
| container: | ||
| image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform | ||
| env: | ||
| CHECKPOINT_DISABLE: "1" | ||
| timeout-minutes: 120 | ||
| steps: | ||
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | ||
| - name: Get yarn cache directory path | ||
| id: global-cache-dir-path | ||
| run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT | ||
| - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 | ||
| id: global-cache | ||
| with: | ||
| path: ${{ steps.global-cache-dir-path.outputs.dir }} | ||
| key: ${{ runner.os }}-integration-yarn-${{ hashFiles('**/yarn.lock') }} | ||
|
|
||
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | ||
| - name: Set up Go | ||
| uses: actions/setup-go@fac708d6674e30b6ba41289acaab6d4b75aa0753 # v4.0.1 | ||
| with: | ||
| go-version-file: go.mod | ||
| cache: true | ||
|
|
||
| - run: go mod download | ||
|
|
||
| - name: Build Go binary | ||
| run: | | ||
| go build -o terraform-provider-null | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | ||
| with: | ||
| node-version: "18.x" | ||
|
|
||
| - name: Install cdktf-registry-docs | ||
| run: npm install -g [email protected] | ||
|
|
||
| - name: Run conversion | ||
| run: | | ||
| chmod +x terraform-provider-null | ||
| cdktf-registry-docs convert --language='typescript,python' --parallel-conversions-per-document=2 --provider-from-binary="$(pwd)/terraform-provider-null" --additional-provider-requirements="hashicorp/aws@~> 5.0.0" . | ||
| env: | ||
| TF_PLUGIN_CACHE_DIR: ${{ steps.global-cache-dir-path.outputs.dir }}/terraform-plugins | ||
|
|
||
| - name: Git push cdktf docs | ||
| run: | | ||
| git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}" | ||
| git config --global user.email "${{ env.CI_COMMIT_EMAIL }}" | ||
| git checkout -b "cdktf-docs-${{ github.sha }}" | ||
| git add . | ||
| git commit -a -m "Update cdktf docs" | ||
| git push "https://${{ env.CI_COMMIT_AUTHOR }}:${{ secrets.TF_DEVEX_COMMIT_GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" | ||
| - name: Create Pull Request | ||
| uses: peter-evans/create-pull-request@284f54f989303d2699d373481a0cfa13ad5a6666 # v5.0.1 | ||
| with: | ||
| commit-message: "docs: update cdktf documentation" | ||
| title: "docs: update cdktf documentation" | ||
| body: "This PR updates the cdktf related documentation based on the current HCL-based documentation. It is automatically created by the cdktf-documentation GitHub action." | ||
| token: ${{ secrets.TF_DEVEX_COMMIT_GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| --- | ||
|
|
||
| <!-- Please do not edit this file, it is generated. --> | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "null_data_source Data Source - terraform-provider-null" | ||
| subcategory: "" | ||
| description: |- | ||
| The null_data_source data source implements the standard data source lifecycle but does not | ||
| interact with any external APIs. | ||
| Historically, the null_data_source was typically used to construct intermediate values to re-use elsewhere in configuration. The | ||
| same can now be achieved using locals https://developer.hashicorp.com/terraform/language/values/locals or the terraform_data resource type https://developer.hashicorp.com/terraform/language/resources/terraform-data in Terraform 1.4 and later. | ||
| --- | ||
|
|
||
| # null_data_source | ||
|
|
||
| The `null_data_source` data source implements the standard data source lifecycle but does not | ||
| interact with any external APIs. | ||
|
|
||
| Historically, the `null_data_source` was typically used to construct intermediate values to re-use elsewhere in configuration. The | ||
| same can now be achieved using [locals](https://developer.hashicorp.com/terraform/language/values/locals) or the [terraform_data resource type](https://developer.hashicorp.com/terraform/language/resources/terraform-data) in Terraform 1.4 and later. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```python | ||
| import constructs as constructs | ||
| import cdktf as cdktf | ||
| # Provider bindings are generated by running cdktf get. | ||
| # See https://cdk.tf/provider-generation for more details. | ||
| import ...gen.providers.aws as aws | ||
| import ...gen.providers.null as NullProvider | ||
| class MyConvertedCode(cdktf.TerraformStack): | ||
| def __init__(self, scope, name): | ||
| super().__init__(scope, name) | ||
| # In most cases loops should be handled in the programming language context and | ||
| # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input | ||
| # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source | ||
| # you need to keep this like it is. | ||
| aws_instance_blue_count = cdktf.TerraformCount.of( | ||
| cdktf.Token.as_number("3")) | ||
| aws_instance_blue = aws.instance.Instance(self, "blue", | ||
| ami="ami-0dcc1e21636832c5d", | ||
| instance_type="m5.large", | ||
| count=aws_instance_blue_count | ||
| ) | ||
| # In most cases loops should be handled in the programming language context and | ||
| # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input | ||
| # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source | ||
| # you need to keep this like it is. | ||
| aws_instance_green_count = cdktf.TerraformCount.of( | ||
| cdktf.Token.as_number("3")) | ||
| aws_instance_green = aws.instance.Instance(self, "green", | ||
| ami="ami-0dcc1e21636832c5d", | ||
| instance_type="m5.large", | ||
| count=aws_instance_green_count | ||
| ) | ||
| data_null_data_source_values = | ||
| null.data_null_data_source.DataNullDataSource(self, "values", | ||
| inputs={ | ||
| "all_server_ids": cdktf.Token.as_string( | ||
| cdktf.Fn.concat([ | ||
| cdktf.property_access(aws_instance_green, ["*", "id"]), | ||
| cdktf.property_access(aws_instance_blue, ["*", "id"]) | ||
| ])), | ||
| "all_server_ips": cdktf.Token.as_string( | ||
| cdktf.Fn.concat([ | ||
| cdktf.property_access(aws_instance_green, ["*", "private_ip"]), | ||
| cdktf.property_access(aws_instance_blue, ["*", "private_ip"]) | ||
| ])) | ||
| } | ||
| ) | ||
| cdktf.TerraformOutput(self, "all_server_ids", | ||
| value=cdktf.property_access(data_null_data_source_values.outputs, ["\"all_server_ids\"" | ||
| ]) | ||
| ) | ||
| cdktf.TerraformOutput(self, "all_server_ips", | ||
| value=cdktf.property_access(data_null_data_source_values.outputs, ["\"all_server_ips\"" | ||
| ]) | ||
| ) | ||
| aws.elb.Elb(self, "main", | ||
| instances=cdktf.Token.as_list( | ||
| cdktf.property_access(data_null_data_source_values.outputs, ["\"all_server_ids\"" | ||
| ])), | ||
| listener=[ElbListener( | ||
| instance_port=8000, | ||
| instance_protocol="http", | ||
| lb_port=80, | ||
| lb_protocol="http" | ||
| ) | ||
| ] | ||
| ) | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
|
|
||
| ## Schema | ||
|
|
||
| ### Optional | ||
|
|
||
| - `has_computed_default` (String) If set, its literal value will be stored and returned. If not, its value defaults to `"default"`. This argument exists primarily for testing and has little practical use. | ||
| - `inputs` (Map of String) A map of arbitrary strings that is copied into the `outputs` attribute, and accessible directly for interpolation. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String, Deprecated) This attribute is only present for some legacy compatibility issues and should not be used. It will be removed in a future version. | ||
| - `outputs` (Map of String) After the data source is "read", a copy of the `inputs` map. | ||
| - `random` (String) A random value. This is primarily for testing and has little practical use; prefer the [hashicorp/random provider](https://registry.terraform.io/providers/hashicorp/random) for more practical random number use-cases. | ||
|
|
||
| <!-- cache-key: cdktf-0.17.0-pre.15 input-fa7d10970659f6da116e619b9538e2de36a25181c2f5cde4897e5278b25c8de8 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| page_title: "Provider: Null" | ||
| description: |- | ||
| The null provider provides no-op constructs that can be useful helpers in tricky cases. | ||
| --- | ||
|
|
||
|
|
||
| <!-- Please do not edit this file, it is generated. --> | ||
| # Null Provider | ||
|
|
||
| The `null` provider is a rather-unusual provider that has constructs that | ||
| intentionally do nothing. This may sound strange, and indeed these constructs | ||
| do not need to be used in most cases, but they can be useful in various | ||
| situations to help orchestrate tricky behavior or work around limitations. | ||
|
|
||
| The documentation of each feature of this provider, accessible via the | ||
| navigation, gives examples of situations where these constructs may prove | ||
| useful. | ||
|
|
||
| Usage of the `null` provider can make a Terraform configuration harder to | ||
| understand. While it can be useful in certain cases, it should be applied with | ||
| care and other solutions preferred when available. | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| <!-- cache-key: cdktf-0.17.0-pre.15 input-d1e617f2c2c9e3d78274dec7e778b31db141151845c95c532b7c79f752c28fff --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
|
|
||
| <!-- Please do not edit this file, it is generated. --> | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "null_resource Resource - terraform-provider-null" | ||
| subcategory: "" | ||
| description: |- | ||
| The null_resource resource implements the standard resource lifecycle but takes no further action. On Terraform 1.4 and later, use the terraform_data resource type https://developer.hashicorp.com/terraform/language/resources/terraform-data instead. | ||
| The triggers argument allows specifying an arbitrary set of values that, when changed, will cause the resource to be replaced. | ||
| --- | ||
|
|
||
| # null_resource | ||
|
|
||
| The `null_resource` resource implements the standard resource lifecycle but takes no further action. On Terraform 1.4 and later, use the [terraform_data resource type](https://developer.hashicorp.com/terraform/language/resources/terraform-data) instead. | ||
|
|
||
| The `triggers` argument allows specifying an arbitrary set of values that, when changed, will cause the resource to be replaced. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```python | ||
| import constructs as constructs | ||
| import cdktf as cdktf | ||
| # Provider bindings are generated by running cdktf get. | ||
| # See https://cdk.tf/provider-generation for more details. | ||
| import ...gen.providers.aws as aws | ||
| import ...gen.providers.null as NullProvider | ||
| class MyConvertedCode(cdktf.TerraformStack): | ||
| def __init__(self, scope, name): | ||
| super().__init__(scope, name) | ||
| # In most cases loops should be handled in the programming language context and | ||
| # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input | ||
| # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source | ||
| # you need to keep this like it is. | ||
| aws_instance_cluster_count = cdktf.TerraformCount.of( | ||
| cdktf.Token.as_number("3")) | ||
| aws_instance_cluster = aws.instance.Instance(self, "cluster", | ||
| ami="ami-0dcc1e21636832c5d", | ||
| instance_type="m5.large", | ||
| count=aws_instance_cluster_count | ||
| ) | ||
| null_provider_resource_cluster = NullProvider.resource.Resource(self, "cluster_1", | ||
| connection=cdktf.SSHProvisionerConnection( | ||
| host=cdktf.Fn.element( | ||
| cdktf.property_access(aws_instance_cluster, ["*", "public_ip"]), 0) | ||
| ), | ||
| triggers=[{ | ||
| "cluster_instance_ids": cdktf.Fn.join(",", | ||
| cdktf.Token.as_list( | ||
| cdktf.property_access(aws_instance_cluster, ["*", "id"]))) | ||
| } | ||
| ], | ||
| provisioners=[cdktf.FileProvisioner( | ||
| type="remote-exec", | ||
| inline=["bootstrap-cluster.sh " + | ||
| cdktf.Token.as_string( | ||
| cdktf.Fn.join(" ", | ||
| cdktf.Token.as_list( | ||
| cdktf.property_access(aws_instance_cluster, ["*", "private_ip" | ||
| ])))) | ||
| ] | ||
| ) | ||
| ] | ||
| ) | ||
| # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. | ||
| null_provider_resource_cluster.override_logical_id("cluster") | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
|
|
||
| ## Schema | ||
|
|
||
| ### Optional | ||
|
|
||
| - `triggers` (Map of String) A map of arbitrary strings that, when changed, will force the null resource to be replaced, re-running any associated provisioners. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) This is set to a random value at create time. | ||
|
|
||
| <!-- cache-key: cdktf-0.17.0-pre.15 input-64734d251545a8102312ebf4d3b3acb298b9d9b9070729db262d9ba29176dd3d --> |
Oops, something went wrong.