Skip to content

Commit 5f62daa

Browse files
feat: update README with a basic example usage and references (#36)
1 parent 69b7476 commit 5f62daa

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
11
# CircleCI Terraform Provider
22
The CircleCI Terraform Provider enable customers to manage CircleCI projects with IaC patterns, matching the same patterns used to manage GitHub repos. For large-scale organizations, this enables automated project creation for new teams or projects.
33

4+
## Usage
5+
The current documentation is found [here](https://registry.terraform.io/providers/CircleCI-Public/circleci/latest/docs).
6+
Define the provider:
7+
```hcl
8+
terraform {
9+
required_providers {
10+
circleci = {
11+
source = "CircleCI-Public/circleci"
12+
version = "0.1.1"
13+
}
14+
}
15+
}
16+
17+
provider "circleci" {
18+
host = "https://circleci.com/api/v2/"
19+
#key = "*****" # here you set you CircleCI API Key
20+
}
21+
```
22+
Start defining Data Sources and Resources. For example:
23+
```hcl
24+
resource "circleci_project" "test_project" {
25+
name = "Project_Name"
26+
project_provider = "github"
27+
organization_id = "********-****-****-****-****************"
28+
}
29+
```
30+
31+
Use the Official [CircleCI API documentation](https://circleci.com/docs/api/v2/index.html) to check which valid values might be needed for some resources.
32+
433
## Upcoming Features in the Next Release
534

635
- Import existing resources

0 commit comments

Comments
 (0)