Skip to content

Commit fa5ff73

Browse files
committed
chore: update docs
1 parent 785e3e5 commit fa5ff73

4 files changed

Lines changed: 119 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,4 @@ coverage.out
4545
!CHANGELOG.md
4646
!CONTRIBUTING.md
4747
!README.md
48+
!docs/**/*.md

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Tests](https://github.com/svalabs/terraform-provider-forgejo/actions/workflows/test.yml/badge.svg)
44
![Release](https://github.com/svalabs/terraform-provider-forgejo/actions/workflows/release.yml/badge.svg)
5-
![Test Coverage](https://img.shields.io/badge/Coverage-74.4%25-brightgreen?logo=go)
5+
![Test Coverage](https://img.shields.io/badge/Coverage-74.7%25-brightgreen?logo=go)
66
![Version](https://img.shields.io/github/v/release/svalabs/terraform-provider-forgejo?logo=terraform&label=Version)
77
![License](https://img.shields.io/github/license/svalabs/terraform-provider-forgejo?logo=github&label=License)
88

@@ -24,6 +24,7 @@ Resources:
2424
- `forgejo_organization` ([documentation](docs/resources/organization.md))
2525
- `forgejo_organization_action_secret` ([documentation](docs/resources/organization_action_secret.md))
2626
- `forgejo_organization_action_variable` ([documentation](docs/resources/organization_action_variable.md))
27+
- `forgejo_personal_access_token` ([documentation](docs/resources/personal_access_token.md))
2728
- `forgejo_repository` ([documentation](docs/resources/repository.md))
2829
- `forgejo_repository_action_secret` ([documentation](docs/resources/repository_action_secret.md))
2930
- `forgejo_repository_action_variable` ([documentation](docs/resources/repository_action_variable.md))
@@ -40,6 +41,7 @@ Data Sources:
4041
- `forgejo_gpg_key` ([documentation](docs/data-sources/gpg_key.md))
4142
- `forgejo_organization` ([documentation](docs/data-sources/organization.md))
4243
- `forgejo_organization_action_variable` ([documentation](docs/data-sources/organization_action_variable.md))
44+
- `forgejo_personal_access_token` ([documentation](docs/data-sources/personal_access_token.md))
4345
- `forgejo_repository` ([documentation](docs/data-sources/repository.md))
4446
- `forgejo_repository_action_variable` ([documentation](docs/data-sources/repository_action_variable.md))
4547
- `forgejo_ssh_key` ([documentation](docs/data-sources/ssh_key.md))
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "forgejo_personal_access_token Data Source - forgejo"
4+
subcategory: ""
5+
description: |-
6+
Forgejo personal access token data source.
7+
---
8+
9+
# forgejo_personal_access_token (Data Source)
10+
11+
Forgejo personal access token data source.
12+
13+
## Example Usage
14+
15+
```terraform
16+
terraform {
17+
required_providers {
18+
forgejo = {
19+
source = "svalabs/forgejo"
20+
}
21+
}
22+
}
23+
24+
provider "forgejo" {
25+
host = "http://localhost:3000"
26+
}
27+
28+
# Existing user
29+
data "forgejo_user" "test_user" {
30+
login = "test_user"
31+
}
32+
33+
# Existing personal access token
34+
data "forgejo_personal_access_token" "test_token" {
35+
user = data.forgejo_user.test_user.login
36+
name = "test token"
37+
}
38+
```
39+
40+
<!-- schema generated by tfplugindocs -->
41+
## Schema
42+
43+
### Required
44+
45+
- `name` (String) Name of the personal access token.
46+
- `user` (String) Name of the user.
47+
48+
### Read-Only
49+
50+
- `id` (Number) ID of the personal access token.
51+
- `scopes` (Set of String) Scopes of the personal access token.
52+
- `token_last_eight` (String) Last eight characters of the personal access token.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "forgejo_personal_access_token Resource - forgejo"
4+
subcategory: ""
5+
description: |-
6+
Forgejo personal access token resource.
7+
Note: Due to an upstream limitation, one cannot create access tokens when authorized with access tokens. Use basic-auth instead.
8+
---
9+
10+
# forgejo_personal_access_token (Resource)
11+
12+
Forgejo personal access token resource.
13+
14+
**Note**: Due to an upstream limitation, one cannot create access tokens when authorized with access tokens. Use basic-auth instead.
15+
16+
## Example Usage
17+
18+
```terraform
19+
terraform {
20+
required_providers {
21+
forgejo = {
22+
source = "svalabs/forgejo"
23+
}
24+
}
25+
}
26+
27+
variable "test_password" { sensitive = true }
28+
29+
provider "forgejo" {
30+
host = "http://localhost:3000"
31+
// Due to an upstream limitation, one cannot create access tokens when authorized with an access token.
32+
// Use basic-auth instead (FORGEJO_USERNAME / FORGEJO_PASSWORD environment variables).
33+
}
34+
35+
resource "forgejo_user" "test_user" {
36+
login = "test_user"
37+
email = "test_user@localhost.localdomain"
38+
password = var.test_password
39+
}
40+
41+
resource "forgejo_personal_access_token" "test_token" {
42+
user = forgejo_user.test_user.login
43+
name = "test token"
44+
scopes = [
45+
"read:repository"
46+
]
47+
}
48+
```
49+
50+
<!-- schema generated by tfplugindocs -->
51+
## Schema
52+
53+
### Required
54+
55+
- `name` (String) Name of the personal access token. Changing this forces a new resource to be created.
56+
- `scopes` (Set of String) Scopes of the personal access token. Changing this forces a new resource to be created.
57+
- `user` (String) Name of the user. Changing this forces a new resource to be created.
58+
59+
### Read-Only
60+
61+
- `id` (Number) Numeric identifier of the personal access token.
62+
- `token` (String, Sensitive) The personal access token.
63+
- `token_last_eight` (String) Last eight characters of the personal access token.

0 commit comments

Comments
 (0)