Merge pull request #8 from bytebase/chore/update

chore: several updates

Author: d-bytebase

.github/workflows/release.yml

@@ -12,12 +12,31 @@
 name: release
 on:
   push:
-    tags:
-      - 'v*'
+    branches:
+      - main
+    paths:
+      - "VERSION"
 permissions:
   contents: write
 jobs:
+  create-tag:
+    name: Create Tag
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Get Version
+        id: get-version
+        run: |
+          verion=`cat VERSION`
+          echo "::set-output name=version::$verion"
+      - name: Create Tag
+        uses: negz/create-tag@v1
+        with:
+          version: v${{ steps.get-version.outputs.version }}
+          message: "Release v${{ steps.get-version.outputs.version }}"
+          token: ${{ secrets.GITHUB_TOKEN }}
   goreleaser:
+    needs: create-tag
     runs-on: ubuntu-latest
     steps:
       -

Makefile

@@ -1,9 +1,9 @@
 TEST?=$$(go list ./... | grep -v 'vendor')
-HOSTNAME=registry.terraform.io
+HOSTNAME=terraform.local
 NAMESPACE=bytebase
 NAME=bytebase
 BINARY=terraform-provider-${NAMESPACE}
-VERSION=0.0.1
+VERSION=${shell cat ./VERSION}
 OS_ARCH=darwin_amd64
 
 default: install

README.md

@@ -61,6 +61,9 @@ go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs --provider-na
 
 Follow [this doc](https://developer.hashicorp.com/terraform/registry/providers/publishing) to publish the provider.
 
-Note:
+> Note:
+> We need to publish a new tag for a new version, the tag must be a valid [Semantic Version](https://semver.org/) **preceded with a v (for example, v1.2.3)**. There must not be a branch name with the same name as the tag.
 
-We need to publish a new tag for a new version, the tag must be a valid [Semantic Version](https://semver.org/) **preceded with a v (for example, v1.2.3)**. There must not be a branch name with the same name as the tag.
+1. Develop and merge the feature code.
+2. Create a new PR to update the version in [`./VERSION`](./VERSION)
+3. After the version is updated, the action [`./.github/workflows/release.yml`](./.github/workflows/release.yml) will use the newest version `x.y.z` to create a new tag `vx.y.z`, then use the tag to create the release.

VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

docs/data-sources/environments.md

@@ -8,9 +8,20 @@ description: |-
 
 # bytebase_environments (Data Source)
 
-The environment data source.
+The environment data source. You can list environments through `bytebase_environments` data source.
 
+## Example Usage
 
+```terraform
+# List environments
+data "bytebase_environments" "all" {}
+
+output "all_environments" {
+  value = data.bytebase_environments.all.environments
+}
+```
+
+You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/main.tf) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/instances.md

@@ -8,9 +8,20 @@ description: |-
 
 # bytebase_instances (Data Source)
 
-The instance data source.
+The instance data source. You can list instances through `bytebase_instances` data source.
 
+## Example Usage
 
+```terraform
+# List instances
+data "bytebase_instances" "all" {}
+
+output "all_instances" {
+  value = data.bytebase_instances.all.instances
+}
+```
+
+You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/main.tf) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/index.md

@@ -1,22 +1,53 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "bytebase Provider"
+page_title: "Bytebase Provider"
 subcategory: ""
 description: |-
-  
+  The Bytebase Terraform provider to manage your Bytebase resources.
 ---
 
-# bytebase Provider
+# Bytebase Provider
 
+This is the Bytebase Terraform provider to manage your Bytebase resources. For now we support manage the Bytebase instances and environments.
 
+## Example Usage
 
+> Require Terraform 0.13+
 
+```terraform
+# Configure the Bytebase Provider
+
+terraform {
+  required_providers {
+    bytebase = {
+      source = "bytebase/bytebase"
+      version = "0.0.1"
+    }
+  }
+}
+
+provider "bytebase" {
+  email        = "<Your Bytebase account email>"
+  password     = "<Your Bytebase account password>"
+  bytebase_url = "<Your Bytebase OpenAPI URL>"
+}
+```
+
+```terraform
+# Usage example
+# Create a new environment named "dev"
+resource "bytebase_environment" "dev" {
+  name = "dev"
+}
+```
+
+You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/main.tf) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
 
-- `bytebase_url` (String) The OpenAPI URL for your Bytebase server.
-- `email` (String) The Bytebase user account email.
-- `password` (String, Sensitive) The Bytebase user account password.
+- `bytebase_url` (String) The OpenAPI URL for your Bytebase server. If not provided in the configuration, you must set the `BYTEBASE_URL` variable in the environment.
+- `email` (String) The Bytebase user account email. If not provided in the configuration, you must set the `BYTEBASE_USER_EMAIL` variable in the environment.
+- `password` (String, Sensitive) The Bytebase user account password. If not provided in the configuration, you must set the `BYTEBASE_USER_PASSWORD` variable in the environment.

docs/resources/environment.md

@@ -8,9 +8,18 @@ description: |-
 
 # bytebase_environment (Resource)
 
-The environment resource.
+The environment resource. You can read, create, update or delete a single environment through `bytebase_environment` resource.
 
+## Example Usage
 
+```terraform
+# Create a new environment named "dev"
+resource "bytebase_environment" "dev" {
+  name = "dev"
+}
+```
+
+You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/main.tf) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/instance.md

@@ -8,9 +8,21 @@ description: |-
 
 # bytebase_instance (Resource)
 
-The instance resource.
+The instance resource. You can read, create, update or delete a single instance through `bytebase_instance` resource.
 
+## Example Usage
 
+```terraform
+# Create a new instance named "dev instance"
+resource "bytebase_instance" "dev_instance" {
+  name        = "dev instance"
+  engine      = "POSTGRES"
+  host        = "127.0.0.1"
+  environment = "dev"
+}
+```
+
+You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/main.tf) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

examples/environments/main.tf

@@ -0,0 +1,29 @@
+terraform {
+  required_providers {
+    bytebase = {
+      version = "0.0.2"
+      source  = "terraform.local/bytebase/bytebase"
+    }
+  }
+}
+
+variable "environment_name" {
+  type    = string
+  default = ""
+}
+
+# List all environment
+data "bytebase_environments" "all" {}
+
+output "all_environments" {
+  value = data.bytebase_environments.all.environments
+}
+
+# Only returns specific environment
+output "environment" {
+  value = {
+    for environment in data.bytebase_environments.all.environments :
+    environment.id => environment
+    if environment.name == var.environment_name
+  }
+}