diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml deleted file mode 100644 index f1a1d2c..0000000 --- a/.github/workflows/lint.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Lint & test - -on: - pull_request: - branches: - - main - -jobs: - lint: - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Go - uses: actions/setup-go@v5 - with: - go-version: 1.20 - - - name: Install Make - run: sudo apt-get install make - - - name: Run make lint - run: make lint - - - name: Run make testacc - run: make testacc diff --git a/templates/resources/private_key.md.tmpl b/templates/resources/private_key.md.tmpl new file mode 100644 index 0000000..7afa434 --- /dev/null +++ b/templates/resources/private_key.md.tmpl @@ -0,0 +1,35 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +~> **Security Notice** The private key generated by this resource will +be stored *unencrypted* in your Terraform state file. + +This is a *logical resource*, contributing only to the current Terraform +state without creating any external managed resources. + + +## Example Usage + +{{ tffile "examples/resources/x25519_private_key/resource.tf" }} + +{{ .SchemaMarkdown | trimspace }} + +## Generating a New Key + +Since a private key is a logical resource that resides solely in the Terraform state, +it persists until explicitly destroyed by the user. + +To force the generation of a new key within an existing state, taint the +private key instance: + +```bash +terraform taint x25519_private_key.example +```