Skip to content

Commit 5088adc

Browse files
committed
add deprecation warning to coder_git_auth
1 parent 7e2a01c commit 5088adc

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/data-sources/git_auth.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@
33
page_title: "coder_git_auth Data Source - terraform-provider-coder"
44
subcategory: ""
55
description: |-
6-
(Deprecated: use the coder_external_auth data source instead). Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated git clone in startup scripts.
6+
~> Deprecated
7+
Use the coder_external_auth data source instead.
8+
Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated git clone in startup scripts.
79
---
810

911
# coder_git_auth (Data Source)
1012

11-
(**Deprecated**: use the `coder_external_auth` data source instead). Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.
13+
~> **Deprecated**
14+
Use the `coder_external_auth` data source instead.
15+
16+
Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.
1217

1318
## Example Usage
1419

provider/gitauth.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ func gitAuthDataSource() *schema.Resource {
1616
SchemaVersion: 1,
1717

1818
DeprecationMessage: "Use the `coder_external_auth` data source instead.",
19-
Description: "(**Deprecated**: use the `coder_external_auth` data source instead). Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.",
19+
Description: "~> **Deprecated**\nUse the `coder_external_auth` data source instead.\n\nUse this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.",
2020
ReadContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
2121
rawID, ok := rd.GetOk("id")
2222
if !ok {

0 commit comments

Comments
 (0)