Skip to content

Version compatibility with Coder releases #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
matifali opened this issue Aug 12, 2024 · 2 comments · Fixed by #71
Closed

Version compatibility with Coder releases #69

matifali opened this issue Aug 12, 2024 · 2 comments · Fixed by #71
Labels
docs Improvements or additions to documentation

Comments

@matifali
Copy link
Member

matifali commented Aug 12, 2024

We should document on the provider landing page the minimum version required of Coder compatible with each provider release and warn/fail if it doesn't match.
Screenshot 2024-08-12 at 11 00 09 AM

Preview generated at https://registry.terraform.io/tools/doc-preview with following markdown,

Code
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "coderd Provider"
subcategory: ""
description: |-
  
---

# coderd Provider

~> **Warning**
Compatible with Coder version [2.14.0](https://github.com/coder/coder/releases/tag/v2.14.0) and above only.
 

## Example Usage

```terraform
provider "coderd" {
  # example configuration here
}

Schema

Optional

  • default_organization_id (String) Default organization ID to use when creating resources. Defaults to the first organization the token has access to.
  • token (String) API token for communicating with the deployment. Most resource types require elevated permissions. Defaults to $CODER_SESSION_TOKEN.
  • url (String) URL to the Coder deployment. Defaults to $CODER_URL.
</details>
@coder-labeler coder-labeler bot added the docs Improvements or additions to documentation label Aug 12, 2024
@ethanndickson
Copy link
Member

Good idea, I'll have to figure out what the minimum version is, because it's almost certainly older than 2.14.

@matifali
Copy link
Member Author

Yes, its just an example. And as we make new releases we can automate this warning for next versions as part of the docs gen script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants