kelvintaywl / terraform-provider-circleci

(Unofficial) Terraform Provider for CircleCI
https://registry.terraform.io/providers/kelvintaywl/circleci/latest
Mozilla Public License 2.0
12 stars 3 forks source link

Update Provider Documentation #59

Closed jtreutel closed 6 months ago

jtreutel commented 6 months ago

Info

Terraform version: 1.7.4

Current Behavior:

When inserting the provider into a Terraform plan as shown on the docs page, Terraform throws the following error:

│ Error: Failed to query available provider packages
│ 
│ Could not retrieve the list of available versions for provider hashicorp/circleci: provider registry registry.terraform.io does not have a provider named
│ registry.terraform.io/hashicorp/circleci
│ 
│ All modules should specify their required_providers so that external consumers will get the correct providers when using a module. To see which modules are
│ currently depending on hashicorp/circleci, run the following command:
│     terraform providers

Expected behavior:

Dropping the provider config in a Terraform plan would Just Work™.

Proposed solution:

Update `docs/index.html' to change the proposed provider config from this:

provider "circleci" {
  # info goes here
}

to this:

terraform {
  required_providers {
    circleci = {
      source  = "kelvintaywl/circleci"
    }
  }
}

provider "circleci" {
  # info goes here
}
kelvintaywl commented 6 months ago

hey @jtreutel 👋 😉

thanks for the heads-up! I had forgotten about that section, and assumed folks copy-pasted directly from the registry UI as I do:

Screenshot 2024-02-28 at 13 15 10

making a doc PR @ #60

kelvintaywl commented 6 months ago

ayee, I would need to make a release (i.e., v0.12.1) to have the updated docs here be propagated on https://registry.terraform.io/providers/kelvintaywl/circleci/latest/docs 😆

will do so soon 🌮

jtreutel commented 6 months ago

Ah, didn't know it could be found there! TIL! Thanks for the quick fix 💯