Skip to content

Commit

Permalink
Add README and GNUmakefile
Browse files Browse the repository at this point in the history
  • Loading branch information
ddebeau committed Aug 2, 2024
1 parent 8046175 commit 61d62e1
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 6 deletions.
20 changes: 20 additions & 0 deletions GNUmakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

# Modifications copyright (c) Enthought, Inc.
# SPDX-License-Identifier: BSD-3-Clause

default: testacc

# Run acceptance tests
.PHONY: testacc
testacc:
TF_ACC=1 go test ./... -v $(TESTARGS) -timeout 120m

# Generate Quay API
.PHONY: generate-quay-api
generate-quay-api:
openapi-generator generate --generator-name go --git-user-id enthought --git-repo-id terraform-provider-quay --additional-properties=packageName=quay_api,isGoSubmodule=true --skip-validate-spec --input-spec code_generator/quay_api.json --output quay_api && \
gofmt -w quay_api && \
cd quay_api && \
go mod tidy
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# terraform-provider-quay
Terraform provider for the [Quay Project](https://github.com/quay/quay).

Please visit the Terraform registry site for instructions on how to use the provider:

https://registry.terraform.io/providers/enthought/quay/latest/docs

## Developer Instructions
### Build Documentation
The documentation should be updated every time the provider code is changed.
```bash
go generate .
```

### Run Tests
```bash
export QUAY_URL="https://quay.example.com"
export QUAY_TOKEN=""
make testacc
```

### Generate Quay API
```bash
make generate-quay-api
```
6 changes: 0 additions & 6 deletions generate_quay_api.sh

This file was deleted.

0 comments on commit 61d62e1

Please sign in to comment.