Fix README.md

Add codefresh.yml

Author: palson-cf

.gitignore

@@ -1 +1,2 @@
 terraform-provider-codefresh
+dist/

.goreleaser.yml

@@ -0,0 +1,27 @@
+builds:
+- env:
+  - CGO_ENABLED=0
+  goos:
+    - darwin
+    - linux
+    - windows
+archives:
+- replacements:
+    darwin: Darwin
+    linux: Linux
+    windows: Windows
+    386: i386
+    amd64: x86_64
+  format_overrides:
+  - goos: windows
+    format: zip
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+    - '^docs:'
+    - '^test:'

README.md

@@ -1,103 +1,50 @@
-# Setup
+# Terraform provider for Codefresh
 
-Get an API key from [Codefresh](https://g.codefresh.io/user/settings) and set the following scopes:
-* Environments-V2
-* Pipeline
-* Project
-* Repos
-* Step-Type
-* Step-Types
-* View
-
-Add the key to your `.zshrc` file:
+This provider was initialized by [LightStep](https://lightstep.com/) and will be maintained as the official Terraform provider for Codefresh.  
 
-```bash
-export CODEFRESH_API_KEY='xyz'
-```
-
-# Building
-
-```bash
-make build
-```
+The provider is still under development, and can be used as a terraform [third-party plugin](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins) only.
 
-# Testing
+## Requirements
 
-Create a `main.tf` file in the root directory. Add or import resources there.
+- [Terraform](https://www.terraform.io/downloads.html) 0.11+ ;
+- [Go](https://golang.org/doc/install) 1.12+ (to build the provider plugin).
 
-## Example
+## Build
 
-```yaml
-resource "codefresh_project" "test" {
-    name = "test"
-}
+```sh
+go build
 ```
 
-Run `terraform plan` or `terraform apply` as usual. Note this will modify the actual Codefresh configuration.
+## Usage
 
-# Syntax Examples
+Compile or take from the [Releases](https://github.com/codefresh-contrib/terraform-provider-codefresh/releases) `terraform-provider-codefresh` binary and place it locally according the Terraform plugins [documentation](https://www.terraform.io/docs/configuration/providers.html#third-party-plugins).
 
-## Project
+For Linux OS it can be:
 
-```yaml
-resource "codefresh_project" "docker" {
-  name = "docker"
-}
-```
+- _~/.terraform.d/plugins/linux\_amd64_
+- _./terraform.d/plugins/linux\_amd64_. The relative path in your Terraform project.
 
-## Pipeline
-
-```yaml
-resource "codefresh_pipeline" "docker_monorepo" {
-  name    = "docker/docker-monorepo"
-  project = "docker"
-
-  spec = {
-    repo        = "abcinc/monorepo"
-    path        = "./codefresh/docker/docker-monorepo.yaml"
-    revision    = "master"
-    concurrency = 1
-    priority    = 5
-  }
-
-  tags = [
-    "docker",
-  ]
-
-  variables {
-    TAG = "master"
-  }
-}
-```
+## Configuration
 
-## Cron Trigger
+There are two environment variables to configure Codefresh provider:
 
-```yaml
-resource "codefresh_cron_event" "docker_monorepo_cron" {
-  expression = "40 0 * * *"
-  message    = "build monorepo docker"
-}
+- `CODEFRESH_API_URL`. Default value - https://g.codefresh.io/api ;
+- `CODEFRESH_API_KEY`.
 
-resource "codefresh_cron_trigger" "docker_monorepo_cron" {
-  pipeline = "${codefresh_pipeline.docker_monorepo.id}"
-  event    = "${codefresh_cron_event.docker_monorepo_cron.id}"
-}
-```
+Get an API key from [Codefresh](https://g.codefresh.io/user/settings) and set the following scopes:
 
-## Environment
+- Environments-V2
+- Pipeline
+- Project
+- Repos
+- Step-Type
+- Step-Types
+- View
 
-```yaml
-resource "codefresh_environment" "staging" {
-  account_id = "<redacted>"
-  name       = "staging"
-  namespace  = "staging"
-  cluster    = "abcinc-staging"
-}
+```bash
+export CODEFRESH_API_KEY='xyz'
 ```
 
-## User
-```yaml
-resource "codefresh_user" "john_doe" {
-  email = "jdoe@abcinc.com"
-}
-```
+## Examples
+
+See the [examples](examples/).

codefresh.yml

@@ -0,0 +1,35 @@
+version: '1.0'
+stages:
+  - clone
+  - prepare
+  - release
+steps:
+  main_clone:
+    title: 'Cloning main repository...'
+    stage: clone
+    type: git-clone
+    repo: "${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}"
+    revision: "${{CF_REVISION}}"
+    git: "${{GIT_CONTEXT}}"
+
+  prepare_env_vars:
+    title: 'Preparing environment variables...'
+    stage: prepare
+    image: codefreshio/ci-helpers
+    commands:
+      - source /get-token/get-gh-token.sh
+      - cf_export GITHUB_TOKEN
+
+  go_fmt:
+    title: 'Formatting'
+    stage: prepare
+    image: codefresh/goreleaser:${{GOLANG_VERSION}}
+    commands:
+      - go fmt
+
+  release_binaries:
+    title: Create release in Github
+    image: codefresh/goreleaser:${{GOLANG_VERSION}}
+    stage: release
+    commands:
+      - goreleaser release --rm-dist

examples/README.md

@@ -0,0 +1,76 @@
+# Example
+
+```yaml
+resource "codefresh_project" "test" {
+    name = "test"
+}
+```
+
+Run `terraform plan` or `terraform apply` as usual. Note this will modify the actual Codefresh configuration.
+
+# Syntax Examples
+
+## Project
+
+```yaml
+resource "codefresh_project" "docker" {
+  name = "docker"
+}
+```
+
+## Pipeline
+
+```yaml
+resource "codefresh_pipeline" "docker_monorepo" {
+  name    = "docker/docker-monorepo"
+  project = "docker"
+
+  spec = {
+    repo        = "abcinc/monorepo"
+    path        = "./codefresh/docker/docker-monorepo.yaml"
+    revision    = "master"
+    concurrency = 1
+    priority    = 5
+  }
+
+  tags = [
+    "docker",
+  ]
+
+  variables {
+    TAG = "master"
+  }
+}
+```
+
+## Cron Trigger
+
+```yaml
+resource "codefresh_cron_event" "docker_monorepo_cron" {
+  expression = "40 0 * * *"
+  message    = "build monorepo docker"
+}
+
+resource "codefresh_cron_trigger" "docker_monorepo_cron" {
+  pipeline = "${codefresh_pipeline.docker_monorepo.id}"
+  event    = "${codefresh_cron_event.docker_monorepo_cron.id}"
+}
+```
+
+## Environment
+
+```yaml
+resource "codefresh_environment" "staging" {
+  account_id = "<redacted>"
+  name       = "staging"
+  namespace  = "staging"
+  cluster    = "abcinc-staging"
+}
+```
+
+## User
+```yaml
+resource "codefresh_user" "john_doe" {
+  email = "jdoe@abcinc.com"
+}
+```