terraform-provider-woodpecker/docs/index.md

38 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2023-08-25 05:41:13 +00:00
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "woodpecker Provider"
subcategory: ""
description: |-
A Terraform provider used to interact with Woodpecker CI https://woodpecker-ci.org/ resources.
2023-11-26 15:29:01 +00:00
v0.2.x and later versions of the provider work with Woodpecker 2.x+v0.1.x version of the provider works with Woodpecker 2.0.0>1.x>=1.0.0
2023-08-25 05:41:13 +00:00
---
# woodpecker Provider
A Terraform provider used to interact with [Woodpecker CI](https://woodpecker-ci.org/) resources.
2023-11-26 15:29:01 +00:00
- v0.2.x and later versions of the provider work with Woodpecker 2.x+
- v0.1.x version of the provider works with Woodpecker 2.0.0>1.x>=1.0.0
2023-08-25 05:45:47 +00:00
## Example Usage
2023-08-25 05:41:13 +00:00
2023-08-25 05:45:47 +00:00
```terraform
provider "woodpecker" {
server = "https://woodpecker.example.com"
token = "token"
}
```
2023-08-25 05:41:13 +00:00
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
2023-08-25 05:45:47 +00:00
- `server` (String) This is the target Woodpecker CI base API endpoint. It must be provided, but
2023-08-25 05:41:13 +00:00
can also be sourced from the WOODPECKER_SERVER environment
variable.
- `token` (String) A Woodpecker CI Personal Access Token. It must be provided, but
can also be sourced from the WOODPECKER_TOKEN environment
variable.