Skip to content

Commit bb913e4

Browse files
committed
Add goreleaser and organization resource doc
Preparing for https://registry.terraform.io
1 parent a06b3b6 commit bb913e4

File tree

4 files changed

+103
-0
lines changed

4 files changed

+103
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ terraform.tfstate*
33
.terraform
44
main.tf
55
.env
6+
/dist

.goreleaser.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
builds:
2+
- env:
3+
- CGO_ENABLED=0
4+
mod_timestamp: '{{ .CommitTimestamp }}'
5+
flags:
6+
- -trimpath
7+
ldflags:
8+
- '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
9+
goos:
10+
- linux
11+
- darwin
12+
# - windows
13+
# - freebsd
14+
goarch:
15+
- amd64
16+
- arm64
17+
# - arm
18+
# - '386'
19+
ignore:
20+
- goos: darwin
21+
goarch: '386'
22+
binary: '{{ .ProjectName }}_v{{ .Version }}'
23+
archives:
24+
- format: zip
25+
name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}'
26+
checksum:
27+
name_template: '{{ .ProjectName }}_{{ .Version }}_SHA256SUMS'
28+
algorithm: sha256
29+
signs:
30+
- artifacts: checksum
31+
args:
32+
# if you are using this is a GitHub action or some other automated pipeline, you
33+
# need to pass the batch flag to indicate its not interactive.
34+
- "--batch"
35+
- "--local-user"
36+
- "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
37+
- "--output"
38+
- "${signature}"
39+
- "--detach-sign"
40+
- "${artifact}"
41+
release:
42+
# If you want to manually examine the release before its live, uncomment this line:
43+
# draft: true
44+
changelog:
45+
skip: true

docs/index.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# HireFire Provider
2+
3+
The HireFire provider is used to configure resources supported by the
4+
[HireFire API].
5+
6+
[HireFire API]: https://docs.hirefire.io/
7+
8+
## Example Usage
9+
10+
```hcl
11+
provider "hirefire" {
12+
version = "~> 0.3"
13+
api_key = "${var.hirefire_api_key}
14+
}
15+
```
16+
17+
## Argument Reference
18+
19+
The following arguments are supported:
20+
21+
- `api_key` - (required) This is HireFire API key. This can also be specified
22+
with the `HIREFIRE_API_KEY` environment variable.

docs/resources/organization.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Organization resource
2+
3+
Provides a HireFire Organization resource. This can be used to create, modify,
4+
and delete organizations.
5+
6+
## Example Usage
7+
8+
```hcl
9+
resource "hirefire_organization" "my_organization" {
10+
name = "My Organization"
11+
time_zone = "UTC"
12+
}
13+
```
14+
15+
## Argument Reference
16+
17+
The following arguments are supported:
18+
19+
- `name` - (required) The name of the organization.
20+
- `time_zone` - (required) The time zone associated with the organization.
21+
(Verify time zone name on list provided by HireFire UI.)
22+
23+
## Attribute Reference
24+
25+
The following attributes are exported:
26+
27+
- `id` - HireFire's ID of the organization.
28+
29+
## Import
30+
31+
Organizations can be imported using the `id`, e.g.
32+
33+
```bash
34+
terraform import hirefire_organization.my_organization 516a2b53-04c8-424e-8533-99d47ef1f9bf
35+
```

0 commit comments

Comments
 (0)