You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30-27Lines changed: 30 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,33 +10,6 @@ Use HashiCorp's [Plugin Development](https://www.terraform.io/plugin) guide as a
10
10
11
11
See the [Developing The Provider](#developing-the-provider) section below for specifics about this GitLab provider.
12
12
13
-
### GitPod Environment Setup
14
-
15
-
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.
16
-
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
17
-
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
18
-
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
19
-
tests, as described in the "Running Tests/Option 1" section below.
20
-
21
-
22
-
#### Option 1: Manually navigate to GitPod
23
-
24
-
You can manually sign in and open your workspace within GitPod by following these steps:
25
-
26
-
1. Navigate to [GitPod](https://gitpod.io/)
27
-
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.
28
-
1. Click on "Continue with GitHub" and authorize GitPod to access your account.
29
-
1. After you've signed in, select "Projects" along the top menu, click on your forked `terraform-provider-gitlab` project
30
-
1. Hover over either the main branch for your fork or the branch you created for your fork, and click "New Workspace"
31
-
32
-
#### Option 2: Open your GitPod Workspace directly via URL
33
-
34
-
1. Navigate to your fork of the `terraform-provider-gitlab` project in GitHub
35
-
1. Select the branch you want to develop
36
-
1. Add `https://gitpod.io/#` to the front of your URL
37
-
38
-
Your workspace will automatically open the repository and branch that you selected in GitHub.
39
-
40
13
## Before Committing
41
14
42
15
Run `make reviewable` and include any generated files in your commit. This will help ensure your PR passes automated checks.
@@ -87,6 +60,8 @@ Documentation in [/docs](/docs) is auto-generated by [terraform-plugin-docs](htt
87
60
88
61
## Developing The Provider
89
62
63
+
### Set Up Your Local Environment
64
+
90
65
You'll first need [Go](http://www.golang.org) installed on your machine (version 1.16+ is *required*).
91
66
92
67
1. Clone the git repository.
@@ -102,6 +77,34 @@ You'll first need [Go](http://www.golang.org) installed on your machine (version
102
77
$ make build
103
78
```
104
79
80
+
81
+
### Use a Remote Environment via GitPod
82
+
83
+
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.
84
+
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
85
+
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
86
+
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
87
+
tests, as described in the "Running Tests/Option 1" section below.
88
+
89
+
90
+
#### Option 1: Manually navigate to GitPod
91
+
92
+
You can manually sign in and open your workspace within GitPod by following these steps:
93
+
94
+
1. Navigate to [GitPod](https://gitpod.io/)
95
+
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.
96
+
1. Click on "Continue with GitHub" and authorize GitPod to access your account.
97
+
1. After you've signed in, select "Projects" along the top menu, click on your forked `terraform-provider-gitlab` project
98
+
1. Hover over either the main branch for your fork or the branch you created for your fork, and click "New Workspace"
99
+
100
+
#### Option 2: Open your GitPod Workspace directly via URL
101
+
102
+
1. Navigate to your fork of the `terraform-provider-gitlab` project in GitHub
103
+
1. Select the branch you want to develop
104
+
1. Add `https://gitpod.io/#` to the front of your URL
105
+
106
+
Your workspace will automatically open the repository and branch that you selected in GitHub.
107
+
105
108
### Running Tests
106
109
107
110
The acceptance tests can run against a Gitlab instance where you have a token with administrator permissions (likely not gitlab.com).
0 commit comments