Skip to content

Commit

Permalink
Add code change source docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrdon committed Nov 8, 2021
1 parent d8e9f9f commit 35aa413
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 7 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.PHONY: docs release
TEST?=$$(go list ./... | grep -v 'vendor')
HOSTNAME=sleuth.io
NAMESPACE=core
Expand Down Expand Up @@ -28,6 +29,8 @@ test:
go test -i $(TEST) || exit 1
echo $(TEST) | xargs -t -n4 go test $(TESTARGS) -timeout=30s -parallel=4

docs:
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

testacc:
TF_ACC=1 go test $(TEST) -v $(TESTARGS) -timeout 120m
54 changes: 54 additions & 0 deletions docs/resources/code_change_source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "sleuth_code_change_source Resource - terraform-provider-sleuth"
subcategory: ""
description: |-
Sleuth code change source.
---

# sleuth_code_change_source (Resource)

Sleuth code change source.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **deploy_tracking_type** (String) How to track deploys
- **environment_mappings** (Block List, Min: 1) (see [below for nested schema](#nestedblock--environment_mappings))
- **name** (String) Change source name
- **project_slug** (String) The project for this environment
- **repository** (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--repository))

### Optional

- **auto_tracking_delay** (Number) The delay to add to a deployment event
- **collect_impact** (Boolean) Whether to collect impact for its deploys
- **id** (String) The ID of this resource.
- **include_in_dashboard** (Boolean) Whether to include deploys from this change source in the metrics dashboard
- **notify_in_slack** (Boolean) Whether to send Slack notifications for deploys or not
- **path_prefix** (String) What code source path to limit this deployment to. Useful for monorepos

<a id="nestedblock--environment_mappings"></a>
### Nested Schema for `environment_mappings`

Required:

- **branch** (String) The repository branch name for the environment
- **environment_slug** (String) The environment slug or id


<a id="nestedblock--repository"></a>
### Nested Schema for `repository`

Required:

- **name** (String) The repository name
- **owner** (String) The repository owner, usually the organization or user name
- **provider** (String) The repository provider, such as GITHUB
- **url** (String) The repository url, used for links


8 changes: 4 additions & 4 deletions docs/resources/error_impact_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ Sleuth error impact source.

### Required

- **environment_slug** (String) The color for the UI
- **environment_slug** (String) The environment slug
- **error_environment** (String) The environment of the integration provider
- **error_org_key** (String) The organization key of the integration provider
- **error_project_key** (String) The project key of the integration provider
- **name** (String) Environment name
- **project_slug** (String) The project for this environment
- **name** (String) Impact source name
- **project_slug** (String) The project for this impact source
- **provider_type** (String) Integration provider type

### Optional

- **id** (String) The ID of this resource.
- **manually_set_health_threshold** (Number) The environment of the integration provider
- **manually_set_health_threshold** (Number) The manually set threshold to start marking failed values


6 changes: 3 additions & 3 deletions docs/resources/metric_impact_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Sleuth error impact source.

### Required

- **environment_slug** (String) The color for the UI
- **name** (String) Environment name
- **environment_slug** (String) The environment slug
- **name** (String) Impact source name
- **project_slug** (String) The project for this environment
- **provider_type** (String) Integration provider type
- **query** (String) The metric query
Expand All @@ -27,6 +27,6 @@ Sleuth error impact source.

- **id** (String) The ID of this resource.
- **less_is_better** (Boolean) Whether smaller values are better or not
- **manually_set_health_threshold** (Number) The environment of the integration provider
- **manually_set_health_threshold** (Number) The manually set threshold to start marking failed values


0 comments on commit 35aa413

Please sign in to comment.