Merge pull request #936 from PatrickRice-KSC/add_gitpod_support

Implement GitPod integration

Author: timofurrer

.gitpod.yml

@@ -0,0 +1,14 @@
+image: gitpod/workspace-go
+tasks:
+  - init: go get
+  - name: Start acceptance Test Environment
+    command: make testacc-up
+    openMode: split-right
+# Port 8080 is used for acceptance testing, and we don't need to open it when the container comes up
+ports:
+  - port: 8080
+    onOpen: ignore
+vscode:
+    extensions:
+        - golang.Go
+        - hashicorp.terraform

CONTRIBUTING.md

@@ -60,6 +60,8 @@ Documentation in [/docs](/docs) is auto-generated by [terraform-plugin-docs](htt
 
 ## Developing The Provider
 
+### Set Up Your Local Environment
+
 You'll first need [Go](http://www.golang.org) installed on your machine (version 1.16+ is *required*).
 
 1. Clone the git repository.
@@ -75,6 +77,34 @@ You'll first need [Go](http://www.golang.org) installed on your machine (version
    $ make build
    ```
 
+   
+### Use a Remote Environment via GitPod
+
+You can choose to use your own development environment if desired, however a `.gitpod.yml` file is included within the repository to allow the use of [GitPod](https://gitpod.io/) easily. 
+This will allow you to use GitPod's integration with GitHub to quickly start a web-based development environment including Go and Docker, which are necessary 
+for running tests. To use GitPod's integration, you have two different options described below. After you've completed one of the two options, your development environment 
+will be ready within a minute or two. As part of starting up, your development environment will automatically start up the `gitlab-ce` container necessary for running 
+tests, as described in the "Running Tests/Option 1" section below.
+
+
+#### Option 1: Manually navigate to GitPod
+
+You can manually sign in and open your workspace within GitPod by following these steps:
+
+1. Navigate to [GitPod](https://gitpod.io/)
+1. Click [Login](https://gitpod.io/login/) if you have an account, or [Sign Up](https://www.gitpod.io/#get-started) if you do not.
+1. Click on "Continue with GitHub" and authorize GitPod to access your account.
+1. After you've signed in, select "Projects" along the top menu, click on your forked `terraform-provider-gitlab` project
+1. Hover over either the main branch for your fork or the branch you created for your fork, and click "New Workspace"
+
+#### Option 2: Open your GitPod Workspace directly via URL
+
+1. Navigate to your fork of the `terraform-provider-gitlab` project in GitHub
+1. Select the branch you want to develop
+1. Add `https://gitpod.io/#` to the front of your URL
+
+Your workspace will automatically open the repository and branch that you selected in GitHub.
+
 ### Running Tests
 
 The acceptance tests can run against a Gitlab instance where you have a token with administrator permissions (likely not gitlab.com).

README.md

@@ -5,6 +5,7 @@
 # Terraform Provider for Gitlab
 
 [![Tests](https://github.com/gitlabhq/terraform-provider-gitlab/actions/workflows/push.yml/badge.svg)](https://github.com/gitlabhq/terraform-provider-gitlab/actions/workflows/push.yml)
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
 
 - [Documentation](https://www.terraform.io/docs/providers/gitlab/index.html)
 - [Issues](https://github.com/gitlabhq/terraform-provider-gitlab/issues)