Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: document schema bundling in CONTRIBUTING.md #1736

Merged
merged 1 commit into from
Jun 15, 2024
Merged

docs: document schema bundling in CONTRIBUTING.md #1736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/unreleased/INTERNAL-20240614-105429.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: INTERNAL
body: Document schema bundling in CONTRIBUTING.md
time: 2024-06-14T10:54:29.627322+02:00
custom:
Issue: "1736"
Repository: terraform-ls
12 changes: 12 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,18 @@ go test ./internal/terraform/exec/...
go test ./langserver
```

### Bundled schemas

The language server ships with bundled provider schemas of all official HashiCorp and partner providers to allow completions for common providers without the need to initialize a Terraform project first.
These schemas are not checked into version control and are automatically fetched and bundled when the language server is built in CI.

To generate these locally, run
```bash
go generate ./internal/schemas
```

The generated schemas can then be found in `internal/schemas/data`.

## External Dependencies

Terraform uses [Go Modules]((https://blog.golang.org/using-go-modules))
Expand Down